@adaptabletools/adaptable 20.0.0-canary.7 → 20.0.0-canary.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.0.0-canary.7",
+  "version": "20.0.0-canary.8",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { FormContext } from '../PredefinedConfig/Common/FormContext';
-import { Report, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../PredefinedConfig/ExportState';
+import { Report, ReportColumn, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../PredefinedConfig/ExportState';
 import { AdaptableColumn, BaseContext, AdaptableColumnContext } from '../types';
 import { TypeHint } from '../PredefinedConfig/Common/Types';
 import { CsvCell, ExcelCell, ExcelDataType, ExcelRow, IRowNode } from 'ag-grid-enterprise';
@@ -164,7 +164,7 @@ export interface ExternalReport {
     /**
      * Function invoked to return the data (in the form of a `ExportResultData` object)
      */
-    onExport: (context: BaseExportContext) => Promise<ExportResultData>;
+    onExport: (context: ExternalReportContext) => Promise<ExportResultData>;
 }
 /**
  * Defines a custom Export destination
@@ -257,6 +257,11 @@ export interface ReportContext extends BaseExportContext {
      */
     reportData: ExportResultData;
 }
+export interface ExternalReportContext extends BaseExportContext {
+    getGridReportColumns: () => ReportColumn[];
+    convertToExcel: (reportData: ReportData) => Blob;
+    convertToCsv: (reportData: ReportData) => string;
+}
 /**
  * Context used for providing a custom filename for a Report
  */

package/src/Api/Internal/AdaptableInternalApi.js

@@ -187,7 +187,7 @@ export class AdaptableInternalApi extends ApiBase {
         if (firstRowNode == undefined) {
             return {};
         }
-        const firstRowData = { ...firstRowNode?.data } ?? {};
+        const firstRowData = firstRowNode?.data ? { ...firstRowNode?.data } : {};
         // handle CalcCols which are not persisted in the rowModel
         this.getCalculatedColumnApi()
             .getCalculatedColumns()

package/src/Api/Internal/ExportInternalApi.d.ts

@@ -1,7 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { Report, ReportData, ReportFormatType, ReportNameType, SystemReportName } from '../../PredefinedConfig/ExportState';
-import { IRowNode } from 'ag-grid-enterprise';
+import { CsvCell, ExcelCell, ExcelDataType, IRowNode } from 'ag-grid-enterprise';
 import { AdaptableColumn, AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { BaseExportContext, DataFormatType, ExportDestinationType, ExportResultData } from '../../AdaptableOptions/ExportOptions';
 export declare class ExportInternalApi extends ApiBase {
@@ -31,5 +31,13 @@ export declare class ExportInternalApi extends ApiBase {
     sendReportToDestination(reportResult: ExportResultData, report: Report, format: ReportFormatType, destination: ExportDestinationType): void;
     private sendReportToCustomDestination;
     buildBaseExportContext(reportName: ReportNameType, reportFormat: ReportFormatType, exportDestination?: ExportDestinationType): BaseExportContext;
+    createCellCsv(cellContent: any): CsvCell;
+    createCellExcel(cellContent: any, cellType: ExcelDataType): ExcelCell;
+    createCellHeader(cellContent: any): ExcelCell;
     getExternalReportData(externalReportName: ReportNameType, reportFormat: ReportFormatType, exportDestination: ExportDestinationType): Promise<ExportResultData | undefined>;
+    private buildGridReportColumns;
+    private buildExcelConverter;
+    private buildCsvConverter;
+    private executeGridExport;
+    private buildCsvExportParams;
 }

package/src/Api/Internal/ExportInternalApi.js

@@ -1,4 +1,5 @@
 import { ApiBase } from '../Implementation/ApiBase';
+import { createGrid, } from 'ag-grid-enterprise';
 import { createUuid } from '../../PredefinedConfig/Uuid';
 import { ALL_DATA_REPORT, CURRENT_LAYOUT_REPORT, SELECTED_DATA_REPORT, SYSTEM_EXPORT_DESTINATIONS, SYSTEM_REPORT_NAMES, } from '../../Utilities/Constants/GeneralConstants';
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
@@ -222,7 +223,7 @@ export class ExportInternalApi extends ApiBase {
     convertReportDataToArray(reportData) {
         return [
             reportData.columns.map((column) => column.friendlyName),
-            ...reportData.rows.map((row) => reportData.columns.map((column) => row[column.columnId])),
+            ...reportData.rows.map((row) => reportData.columns.map((column) => row[column.field ?? column.columnId])),
         ];
     }
     publishLiveLiveDataChangedEvent(reportDestination, liveDataTrigger, liveReport) {
@@ -298,9 +299,8 @@ export class ExportInternalApi extends ApiBase {
             this.sendReportToCustomDestination(reportResult, report, format, destination);
         }
         if (destination === 'Download') {
-            if (format === 'Excel' || format === 'VisualExcel') {
-                this.logWarn(`Download of Excel files should already be handed by internal APIs, something went wrong`);
-                return;
+            if (reportResult.type === 'excel') {
+                Helper.createDownloadedFile(reportResult.data, this.getReportFileName(report.Name, format, destination), 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
             }
             if (reportResult.type === 'csv') {
                 Helper.createDownloadedFile(reportResult.data, this.getReportFileName(report.Name, format, destination), 'text/csv;encoding:utf-8');
@@ -359,6 +359,29 @@ export class ExportInternalApi extends ApiBase {
             exportDestination,
         };
     }
+    createCellCsv(cellContent) {
+        return {
+            data: {
+                value: cellContent != undefined ? String(cellContent) : null,
+            },
+        };
+    }
+    createCellExcel(cellContent, cellType) {
+        return {
+            data: {
+                value: cellContent != undefined ? String(cellContent) : null,
+                type: cellType,
+            },
+        };
+    }
+    createCellHeader(cellContent) {
+        return {
+            data: {
+                value: cellContent != undefined ? String(cellContent) : null,
+                type: 'String',
+            },
+        };
+    }
     getExternalReportData(externalReportName, reportFormat, exportDestination) {
         const externalReport = this.getExportApi()
             .getExternalReports()
@@ -367,6 +390,73 @@ export class ExportInternalApi extends ApiBase {
             this.logWarn(`External Report '${externalReportName}' not found!`);
             return undefined;
         }
-        return externalReport.onExport(this.buildBaseExportContext(externalReportName, reportFormat, exportDestination));
+        return externalReport.onExport({
+            ...this.buildBaseExportContext(externalReportName, reportFormat, exportDestination),
+            convertToExcel: this.buildExcelConverter(externalReportName, reportFormat, exportDestination),
+            convertToCsv: this.buildCsvConverter(externalReportName, reportFormat, exportDestination),
+            getGridReportColumns: this.buildGridReportColumns(),
+        });
+    }
+    buildGridReportColumns() {
+        return () => this.getAdaptableApi().columnApi.getColumns();
+    }
+    buildExcelConverter(externalReportName, reportFormat, exportDestination) {
+        return (reportData) => {
+            return this.executeGridExport(reportData, externalReportName, reportFormat, exportDestination, (gridApi, exportParams) => gridApi.getDataAsExcel({ ...exportParams }));
+        };
+    }
+    buildCsvConverter(externalReportName, reportFormat, exportDestination) {
+        return (reportData) => {
+            const csvParams = this.buildCsvExportParams(externalReportName, reportFormat, exportDestination);
+            return this.executeGridExport(reportData, externalReportName, reportFormat, exportDestination, (gridApi, exportParams) => gridApi.getDataAsCsv({ ...exportParams, ...csvParams }));
+        };
+    }
+    executeGridExport(reportData, externalReportName, reportFormat, exportDestination, exportFn) {
+        const htmlDivElement = document.createElement('div');
+        let ephemeralGridApi = null;
+        try {
+            const columnDefs = reportData.columns.map((col) => ({
+                colId: col.columnId,
+                field: col.field ?? col.columnId,
+                headerName: col.friendlyName ?? col.columnId,
+                type: col.dataType ?? 'text',
+            }));
+            const gridOptions = { columnDefs, rowData: reportData.rows };
+            const gridParams = {
+                modules: this.getAdaptableApi()
+                    .internalApi.getAdaptableInstance()
+                    .getAgGridRegisteredModules(),
+            };
+            htmlDivElement.style.display = 'none';
+            document.body.appendChild(htmlDivElement);
+            ephemeralGridApi = createGrid(htmlDivElement, gridOptions, gridParams);
+            const exportParams = {
+                fileName: this.getReportFileName(externalReportName, reportFormat, exportDestination),
+                allColumns: true,
+                exportedRows: 'all',
+            };
+            return exportFn(ephemeralGridApi, exportParams);
+        }
+        catch (error) {
+            this.logWarn('Failed to export data:', error);
+            return null;
+        }
+        finally {
+            if (ephemeralGridApi) {
+                ephemeralGridApi.destroy();
+            }
+            if (htmlDivElement?.parentNode) {
+                document.body.removeChild(htmlDivElement);
+            }
+        }
+    }
+    buildCsvExportParams(externalReportName, reportFormat, exportDestination) {
+        const exportOptions = this.getAdaptableApi().optionsApi.getExportOptions();
+        const csvSeparator = typeof exportOptions.csvSeparator === 'function'
+            ? exportOptions.csvSeparator(this.buildBaseExportContext(externalReportName, reportFormat, exportDestination))
+            : exportOptions.csvSeparator;
+        return {
+            columnSeparator: csvSeparator,
+        };
     }
 }

package/src/PredefinedConfig/ExportState.d.ts

@@ -65,6 +65,12 @@ export interface ReportSchedule extends BaseSchedule {
      */
     ExportDestination?: ExportDestinationType;
 }
+export interface ReportColumn extends AdaptableColumnBase {
+    /**
+     * Field in the row to get cell data from; defaults to `columnId`
+     */
+    field?: string;
+}
 /**
  * Defines the data in a Report run by AdapTable
  */
@@ -76,7 +82,7 @@ export interface ReportData {
     /**
      * Columns in the Report
      */
-    columns: AdaptableColumnBase[];
+    columns: ReportColumn[];
     /**
      * Group columns IDs in the Report
      */

package/src/Redux/Store/AdaptableStore.js

@@ -660,7 +660,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return ret;
                 }
-                case InternalRedux.HIGHLIGHT_CELL_DELETE_ALL: {
+                case InternalRedux.HIGHLIGHT_ROW_DELETE_ALL: {
                     const rowHighlightInfos = middlewareAPI.getState().Internal.RowHighlightInfo;
                     const ret = next(action);
                     rowHighlightInfos.forEach((rowHighlightInfo) => {

package/src/agGrid/AgGridExportAdapter.d.ts

@@ -1,13 +1,30 @@
 import { AdaptableAgGrid } from './AdaptableAgGrid';
 import { Report, ReportFormatType } from '../PredefinedConfig/ExportState';
-import { ExcelStyle } from 'ag-grid-enterprise';
+import { CsvExportParams, ExcelExportParams, ExcelStyle } from 'ag-grid-enterprise';
 import { ExportDestinationType, ExportResultData } from '../AdaptableOptions/ExportOptions';
+import { Layout } from '../PredefinedConfig/LayoutState';
 export interface ExportConfig {
     report: Report;
     format: ReportFormatType;
     destination: ExportDestinationType;
     showProgressIndicator: boolean;
 }
+interface ExportProcessContext extends ExportConfig {
+    exportedColumnIds: string[];
+    isExcelReport: boolean;
+    isVisualExcelReport: boolean;
+    isExportingVisibleColumnToJSON: boolean;
+    getCurrent: () => {
+        layout: Layout;
+        groupColumnIds: string[];
+        pivotColumnIds: string[];
+    };
+    isCellPartOfSelection: (rowId: string, columnId: string) => boolean;
+}
+export interface ExportProcessData {
+    exportContext: ExportProcessContext;
+    exportParams: ExcelExportParams | CsvExportParams;
+}
 export declare class AgGridExportAdapter {
     private _adaptableInstance;
     /**
@@ -27,6 +44,10 @@ export declare class AgGridExportAdapter {
     static getExcelClassNameForCell(colId: string, primaryKeyValue: any, userDefinedCellClass?: string | string[]): string;
     destroy(): void;
     exportData(config: ExportConfig): Promise<null | ExportResultData>;
+    /**
+     * Creates export context and parameters for a given export configuration
+     */
+    buildExportProcessData(config: ExportConfig): ExportProcessData;
     private buildExportParams;
     private buildBaseExportParams;
     private computeProcessRowGroupCallback;
@@ -51,3 +72,4 @@ export declare class AgGridExportAdapter {
     private computeSkipColumnHeaders;
     private computeGetCustomContentBelowRow;
 }
+export {};

package/src/agGrid/AgGridExportAdapter.js

@@ -60,14 +60,12 @@ export class AgGridExportAdapter {
                 await waitForTimeout(16);
             }
             this.adaptableApi.exportApi.internalApi.setExportInProgress(config.report.Name, config.format, config.destination);
-            const exportContext = this.buildExportProcessContext(config);
+            const { exportContext, exportParams } = this.buildExportProcessData(config);
             if (exportContext.isVisualExcelReport) {
                 // FIXME AFL patch styles only for exported columns!
                 // or even better, only cells
                 this.patchExcelStyles();
             }
-            const exportParams = this.buildExportParams(exportContext);
-            exportContext.exportedColumnIds = exportParams.columnKeys;
             // 1. easiest case, we download the file using AG Grid
             // these methods will automatically handle the file download
             if (exportContext.destination === 'Download' && exportContext.isExcelReport) {
@@ -116,6 +114,21 @@ export class AgGridExportAdapter {
             }
         }
     }
+    /**
+     * Creates export context and parameters for a given export configuration
+     */
+    buildExportProcessData(config) {
+        const exportContext = this.buildExportProcessContext(config);
+        if (exportContext.isVisualExcelReport) {
+            this.patchExcelStyles();
+        }
+        const exportParams = this.buildExportParams(exportContext);
+        exportContext.exportedColumnIds = exportParams.columnKeys;
+        return {
+            exportContext,
+            exportParams,
+        };
+    }
     buildExportParams(exportContext) {
         const baseExportParams = this.buildBaseExportParams(exportContext);
         if (exportContext.format === 'Excel' || exportContext.format === 'VisualExcel') {
@@ -654,9 +667,9 @@ export class AgGridExportAdapter {
             .map((columnId) => this.adaptableApi.columnApi.getColumnWithColumnId(columnId))
             .map((column) => ({
             columnId: column.columnId,
+            field: column.field ?? column.columnId,
             friendlyName: column.friendlyName,
             dataType: column.dataType,
-            field: column.field ?? column.columnId,
         }));
         const reportData = {
             columns,
@@ -728,27 +741,11 @@ export class AgGridExportAdapter {
                 masterRowNode: node,
                 masterRowData: node?.data,
                 isExpanded: node.expanded,
-                createCellCsv: (cellContent) => {
-                    return {
-                        data: {
-                            value: cellContent != undefined ? String(cellContent) : null,
-                        },
-                    };
-                },
-                createCellExcel: (cellContent, cellType) => {
-                    return {
-                        data: {
-                            value: cellContent != undefined ? String(cellContent) : null,
-                            type: cellType,
-                        },
-                    };
-                },
+                createCellCsv: (cellContent) => this.adaptableApi.exportApi.internalApi.createCellCsv(cellContent),
+                createCellExcel: (cellContent, cellType) => this.adaptableApi.exportApi.internalApi.createCellExcel(cellContent, cellType),
                 createCellHeader: (cellContent) => {
                     return {
-                        data: {
-                            value: cellContent != undefined ? String(cellContent) : null,
-                            type: 'String',
-                        },
+                        ...this.adaptableApi.exportApi.internalApi.createCellHeader(cellContent),
                         // see #masterDetailHeader
                         styleId: '_masterDetailHeader',
                     };

package/src/agGrid/cellRenderers/BadgeRenderer.js

@@ -35,7 +35,8 @@ export const getBadgeRendererForColumn = (badgeStyle, abColumn, api) => {
                 this.eGui.innerHTML = formattedValue;
                 return;
             }
-            if (['NumberArray', 'StringArray'].includes(abColumn.dataType)) {
+            const arrayTypes = ['numberArray', 'textArray'];
+            if (arrayTypes.includes(abColumn.dataType)) {
                 this.renderArrayValues(params, adaptableApi);
             }
             else {

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1741274222010 || Date.now(),
-    VERSION: "20.0.0-canary.7" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1741620176158 || Date.now(),
+    VERSION: "20.0.0-canary.8" || '--current-version--',
 };

package/src/types.d.ts

@@ -185,7 +185,7 @@ export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, AdaptableS
 export type { ChartDefinition, ChartingState, ChartingAggFunc, } from './PredefinedConfig/ChartingState';
 export type { CustomSort, CustomSortState } from './PredefinedConfig/CustomSortState';
 export type { DashboardState, DashboardTab, AdaptableCoordinate, } from './PredefinedConfig/DashboardState';
-export type { ExportState, Report, ReportData, ReportSchedule, SystemReportName, SystemReportNames, SystemReportFormat, ReportRowScope, ReportColumnScope, ReportNameType, ReportFormatType, } from './PredefinedConfig/ExportState';
+export type { ExportState, Report, ReportData, ReportColumn, ReportSchedule, SystemReportName, SystemReportNames, SystemReportFormat, ReportRowScope, ReportColumnScope, ReportNameType, ReportFormatType, } from './PredefinedConfig/ExportState';
 export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, } from './PredefinedConfig/Common/ColumnFilter';
 export type { GridFilter } from './PredefinedConfig/Common/GridFilter';
 export type { FormatColumn, FormatColumnState, FormatColumnRule, FormatColumnPredicate, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, } from './PredefinedConfig/FormatColumnState';