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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.0.0-canary.6",
+  "version": "20.0.0-canary.7",
   "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

@@ -162,9 +162,9 @@ export interface ExternalReport {
      */
     name: string;
     /**
-     * Function invoked to return the data (in the form of a `ReportData` object)
+     * Function invoked to return the data (in the form of a `ExportResultData` object)
      */
-    onRunReport: () => ReportData;
+    onExport: (context: BaseExportContext) => Promise<ExportResultData>;
 }
 /**
  * Defines a custom Export destination

package/src/Api/ExportApi.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
-import { ExportState, Report, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../PredefinedConfig/ExportState';
+import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../PredefinedConfig/ExportState';
 import { CustomDestination, ExportDestinationType, ExportFormContext, ExportResultData, ExternalReport, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
 import { AdaptableColumn } from '../types';
 /**
@@ -139,11 +139,6 @@ export interface ExportApi {
      * @param report Report to Check
      */
     isExternalReport(report: Report): boolean;
-    /**
-     * Runs the report function of the ExternalReport with the given reportName
-     * @param reportName external report name
-     */
-    runExternalReport(reportName: string): ReportData | undefined;
     /**
      * Returns whether the given column is exportable
      */

package/src/Api/Implementation/ExportApiImpl.d.ts

@@ -1,5 +1,5 @@
 import { ExportApi } from '../ExportApi';
-import { ExportState, Report, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../PredefinedConfig/ExportState';
+import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../PredefinedConfig/ExportState';
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { CustomDestination, ExportDestinationType, ExportFormContext, ExportResultData, ExternalReport, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
@@ -36,7 +36,6 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getCustomReports(): Report[];
     getExternalReports(): ExternalReport[];
     isExternalReport(report: Report): boolean;
-    runExternalReport(externalReportName: string): ReportData | undefined;
     isColumnExportable(adaptableColumn: AdaptableColumn): boolean;
     getSupportedExportDestinations(reportFormat: ReportFormatType): ExportDestinationType[];
     exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType): void;

package/src/Api/Implementation/ExportApiImpl.js

@@ -132,14 +132,6 @@ export class ExportApiImpl extends ApiBase {
     isExternalReport(report) {
         return this.getExternalReports()?.find((cr) => cr.name == report.Name) != null;
     }
-    runExternalReport(externalReportName) {
-        const externalReport = this.getExternalReports()?.find((cr) => cr.name == externalReportName);
-        if (!externalReport) {
-            this.logWarn(`External Report '${externalReportName}' not found!`);
-            return undefined;
-        }
-        return externalReport.onRunReport();
-    }
     isColumnExportable(adaptableColumn) {
         const isExportableFn = this.getExportOptions().isColumnExportable;
         if (typeof isExportableFn === 'function') {
@@ -168,6 +160,20 @@ export class ExportApiImpl extends ApiBase {
     exportReport(reportName, format, destination = 'Download') {
         let report = this.getReportByName(reportName);
         if (this.checkItemExists(report, reportName, 'Report')) {
+            if (this.isExternalReport(report)) {
+                // Handle external report
+                this.internalApi
+                    .getExternalReportData(reportName, format, destination)
+                    .then((reportData) => {
+                    if (reportData) {
+                        this.internalApi.sendReportToDestination(reportData, report, format, destination);
+                    }
+                })
+                    .catch((error) => {
+                    this.logWarn(`Failed to get external report data for '${reportName}': ${error}`);
+                });
+                return;
+            }
             this._adaptable.agGridExportAdapter
                 .exportData({
                 report,

package/src/Api/Internal/ActionColumnInternalApi.js

@@ -78,13 +78,14 @@ export class ActionColumnInternalApi extends ApiBase {
         return { actionButtons, actionColumn };
     }
     updateAllActionColumnButtons(actionButtons) {
-        return actionButtons.map((actionButton) => ({
-            ...actionButton,
-            Uuid: createUuid(),
-            command: actionButton.command == undefined
-                ? undefined
-                : this.updateActionButtonCommand(actionButton),
-        }));
+        return actionButtons.map((actionButton) => {
+            actionButton = { ...actionButton };
+            actionButton.Uuid = createUuid();
+            if (actionButton.command) {
+                this.updateActionButtonCommand(actionButton);
+            }
+            return actionButton;
+        });
     }
     updateActionButtonCommand(button) {
         switch (button.command) {
@@ -93,7 +94,7 @@ export class ActionColumnInternalApi extends ApiBase {
                     this.getRowFormApi().displayCreateRowForm();
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Create Row';
-                button.icon = {
+                button.icon = button.icon ?? {
                     name: 'add',
                 };
                 break;
@@ -102,7 +103,7 @@ export class ActionColumnInternalApi extends ApiBase {
                     this.getRowFormApi().displayCloneRowForm(context.primaryKeyValue);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Clone Row';
-                button.icon = {
+                button.icon = button.icon ?? {
                     name: 'clone',
                 };
                 break;
@@ -117,22 +118,18 @@ export class ActionColumnInternalApi extends ApiBase {
                     this.getRowFormOptions().onRowFormSubmit?.(eventInfo);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Delete Row';
-                button.icon = button.icon
-                    ? button.icon
-                    : {
-                        name: 'delete',
-                    };
+                button.icon = button.icon ?? {
+                    name: 'delete',
+                };
                 break;
             case 'edit':
                 button.onClick = (button, context) => {
                     this.getRowFormApi().displayEditRowForm(context.primaryKeyValue);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Edit Row';
-                button.icon = button.icon
-                    ? button.icon
-                    : {
-                        name: 'edit',
-                    };
+                button.icon = button.icon ?? {
+                    name: 'edit',
+                };
                 break;
         }
     }

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

@@ -21,12 +21,7 @@ export declare class ExportInternalApi extends ApiBase {
     getReportColumnScopeShortDescription(report: Report): string[];
     getReportColumnScopeLongDescription(report: Report): string;
     getReportExpressionDescription(report: Report, cols: AdaptableColumn[]): string;
-    getReportDataColumns(report: Report, includePrimaryKey?: boolean): AdaptableColumn[];
-    getReportDataRows(report: Report, columns: AdaptableColumn[], includePrimaryKey?: boolean): Record<string, any>[];
-    getReportData(report: Report, includePrimaryKey?: boolean): ReportData;
-    getReportDataAsArray(report: Report, includePrimaryKey?: boolean): any[][];
     convertReportDataToArray(reportData: ReportData): any[][];
-    getRowObjectForColumnIds(rowNode: IRowNode, columnIds: string[], reportName: string): Record<string, any>;
     publishLiveLiveDataChangedEvent(reportDestination: 'ipushpull' | 'OpenFin', liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated', liveReport?: any): void;
     getCellExportValueFromRowNode(rowNode: IRowNode, columnId: string, isVisualReport?: boolean): any;
     getCellExportValueFromRawValue(rowNode: IRowNode, cellRawValue: any, columnId: string, isVisualReport?: boolean): any;
@@ -36,4 +31,5 @@ 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;
+    getExternalReportData(externalReportName: ReportNameType, reportFormat: ReportFormatType, exportDestination: ExportDestinationType): Promise<ExportResultData | undefined>;
 }

package/src/Api/Internal/ExportInternalApi.js

@@ -1,15 +1,11 @@
-import groupBy from 'lodash/groupBy';
 import { ApiBase } from '../Implementation/ApiBase';
 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 { ExportModuleId } from '../../Utilities/Constants/ModuleConstants';
-import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
 import FormatHelper, { DateFormatter } from '../../Utilities/Helpers/FormatHelper';
 import Helper from '../../Utilities/Helpers/Helper';
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 import { SystemExportBegin, SystemExportEnd } from '../../Redux/ActionsReducers/InternalRedux';
-import { errorOnce } from '../../agGrid/AdaptableLogger';
 export class ExportInternalApi extends ApiBase {
     /**
      * Value Items for Report Name Selection
@@ -211,7 +207,6 @@ export class ExportInternalApi extends ApiBase {
             return `[${report.Name}]`;
         }
         else {
-            // FIXME AFL: maybe fihnd a better description?
             switch (report.ReportRowScope) {
                 case 'AllRows':
                     return '[All Rows]';
@@ -224,138 +219,12 @@ export class ExportInternalApi extends ApiBase {
             }
         }
     }
-    getReportDataColumns(report, includePrimaryKey = false) {
-        let reportColumns = [];
-        let gridColumns = this.getAdaptableApi().columnApi.getExportableColumns();
-        if (this.getAdaptableApi().exportApi.isExternalReport(report)) {
-            return reportColumns;
-        }
-        // first get the cols depending on the Column Scope
-        switch (report.ReportColumnScope) {
-            case 'AllColumns':
-                reportColumns = gridColumns;
-                break;
-            case 'VisibleColumns':
-                reportColumns = gridColumns.filter((c) => c.visible);
-                break;
-            case 'SelectedColumns':
-                // we extract the selected columns from the grid columns to preserve the grid column order
-                const selectedColumnIds = this.getAdaptableApi()
-                    .gridApi.getSelectedCellInfo()
-                    .columns.map((column) => column.columnId);
-                reportColumns = gridColumns.filter((gridColumn) => selectedColumnIds.includes(gridColumn.columnId));
-                break;
-            case 'ScopeColumns':
-                if ('ColumnIds' in report.Scope) {
-                    reportColumns = report.Scope.ColumnIds.map((columnId) => this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId)).filter((c) => c);
-                }
-                else {
-                    reportColumns = this.getAdaptableApi().columnScopeApi.getColumnsInScope(report.Scope);
-                }
-                break;
-        }
-        if (includePrimaryKey) {
-            const pkColumn = reportColumns.find((column) => column.columnId === this.getAdaptableApi().optionsApi.getPrimaryKey());
-            // TODO simplify after we fix the IsPrimaryKey bug
-            // const pkColumn = reportColumns.find(column => column.IsPrimaryKey);
-            if (!pkColumn && !!this.getAdaptableApi().columnApi.getPrimaryKeyColumn()) {
-                reportColumns.push(this.getAdaptableApi().columnApi.getPrimaryKeyColumn());
-            }
-        }
-        return reportColumns;
-    }
-    getReportDataRows(report, columns, includePrimaryKey) {
-        if (ArrayExtensions.IsNullOrEmpty(columns)) {
-            return [];
-        }
-        const columnIds = columns.map((column) => column.columnId);
-        const resultRowData = [];
-        switch (report.ReportRowScope) {
-            case 'AllRows':
-                this.getAdaptableInternalApi().forAllRowNodesDo((rowNode) => {
-                    resultRowData.push(this.getRowObjectForColumnIds(rowNode, columnIds, report.Name));
-                });
-                break;
-            case 'VisibleRows':
-                this.getAdaptableInternalApi().forAllVisibleRowNodesDo((rowNode) => {
-                    resultRowData.push(this.getRowObjectForColumnIds(rowNode, columnIds, report.Name));
-                });
-                break;
-            case 'ExpressionRows':
-                this.getAdaptableInternalApi().forAllRowNodesDo((rowNode) => {
-                    try {
-                        if (this.getAdaptableApi()
-                            .internalApi.getQueryLanguageService()
-                            .evaluateBooleanExpression(report.Query?.BooleanExpression, ExportModuleId, rowNode)) {
-                            resultRowData.push(this.getRowObjectForColumnIds(rowNode, columnIds, report.Name));
-                        }
-                    }
-                    catch (error) {
-                        errorOnce(error.message);
-                    }
-                });
-                break;
-            case 'SelectedRows':
-                // CellSelection
-                const selectedCellInfo = this.getAdaptableApi().gridApi.getSelectedCellInfo();
-                const { gridCells: GridCells } = selectedCellInfo;
-                let selectedCellsByPrimaryKey = groupBy(GridCells, 'primaryKeyValue');
-                // we iterate over all visibleRowNodes to preserve the current order
-                this.getAdaptableInternalApi().forAllVisibleRowNodesDo((rowNode) => {
-                    const rowPrimaryKeyValue = this.getAdaptableApi().gridApi.getPrimaryKeyValueForRowNode(rowNode);
-                    const selectedRowCells = selectedCellsByPrimaryKey[rowPrimaryKeyValue];
-                    if (selectedRowCells) {
-                        const selectedRowColumnIds = selectedRowCells.map((rowCell) => rowCell.column.columnId);
-                        const selectedColumnIds = columnIds.filter((columnId) => selectedRowColumnIds.includes(columnId));
-                        const row = this.getRowObjectForColumnIds(rowNode, selectedColumnIds, report.Name);
-                        if (includePrimaryKey) {
-                            row[this.getAdaptableApi().optionsApi.getPrimaryKey()] = rowPrimaryKeyValue;
-                        }
-                        resultRowData.push(row);
-                    }
-                });
-                // Row Selection
-                const selectedRowInfo = this.getAdaptableApi().gridApi.getSelectedRowInfo();
-                const selectedGridRowPrimaryKeys = selectedRowInfo?.gridRows
-                    ?.filter((gr) => gr.rowInfo.isGroup == false)
-                    .map((gridRow) => gridRow.primaryKeyValue) ?? [];
-                if (selectedGridRowPrimaryKeys.length) {
-                    this.getAdaptableInternalApi().forAllRowNodesDo((rowNode) => {
-                        const rowPrimaryKeyValue = this.getAdaptableApi().gridApi.getPrimaryKeyValueForRowNode(rowNode);
-                        if (selectedGridRowPrimaryKeys.includes(rowPrimaryKeyValue)) {
-                            resultRowData.push(this.getRowObjectForColumnIds(rowNode, columnIds, report.Name));
-                        }
-                    });
-                }
-                break;
-        }
-        return resultRowData;
-    }
-    getReportData(report, includePrimaryKey = false) {
-        if (this.getAdaptableApi().exportApi.isExternalReport(report)) {
-            return this.getAdaptableApi().exportApi.runExternalReport(report.Name);
-        }
-        const columns = this.getReportDataColumns(report, includePrimaryKey);
-        const rows = this.getReportDataRows(report, columns, includePrimaryKey);
-        return { columns, rows };
-    }
-    getReportDataAsArray(report, includePrimaryKey = false) {
-        const reportData = this.getReportData(report, includePrimaryKey);
-        return this.convertReportDataToArray(reportData);
-    }
     convertReportDataToArray(reportData) {
         return [
             reportData.columns.map((column) => column.friendlyName),
             ...reportData.rows.map((row) => reportData.columns.map((column) => row[column.columnId])),
         ];
     }
-    getRowObjectForColumnIds(rowNode, columnIds, reportName) {
-        return columnIds.reduce((result, columnId) => {
-            // FIXME AFL if this method remains, 'false' should be replaced with dynamic value
-            result[columnId] = this.getCellExportValueFromRowNode(rowNode, columnId, false);
-            return result;
-        }, {});
-    }
     publishLiveLiveDataChangedEvent(reportDestination, liveDataTrigger, liveReport) {
         const liveDataChangedInfo = {
             ...this.getAdaptableInternalApi().buildBaseContext(),
@@ -490,4 +359,14 @@ export class ExportInternalApi extends ApiBase {
             exportDestination,
         };
     }
+    getExternalReportData(externalReportName, reportFormat, exportDestination) {
+        const externalReport = this.getExportApi()
+            .getExternalReports()
+            ?.find((cr) => cr.name == externalReportName);
+        if (!externalReport) {
+            this.logWarn(`External Report '${externalReportName}' not found!`);
+            return undefined;
+        }
+        return externalReport.onExport(this.buildBaseExportContext(externalReportName, reportFormat, exportDestination));
+    }
 }

package/src/PredefinedConfig/ExportState.d.ts

@@ -86,19 +86,6 @@ export interface ReportData {
      */
     pivotColumnIds?: string[];
 }
-/**
- * Row Data in the Report
- */
-export interface ReportRow {
-    /**
-     * Data for the row
-     */
-    data: Record<string, any>;
-    /**
-     * Optional children rows for grouped data
-     */
-    children?: ReportRow[];
-}
 /**
  * System report names provided by AdapTable
  */

package/src/agGrid/AgGridExportAdapter.d.ts

@@ -23,6 +23,7 @@ export declare class AgGridExportAdapter {
     private get agGridApi();
     private get adaptableApi();
     private get exportOptions();
+    private get logger();
     static getExcelClassNameForCell(colId: string, primaryKeyValue: any, userDefinedCellClass?: string | string[]): string;
     destroy(): void;
     exportData(config: ExportConfig): Promise<null | ExportResultData>;

package/src/agGrid/AgGridExportAdapter.js

@@ -29,6 +29,9 @@ export class AgGridExportAdapter {
     get exportOptions() {
         return this._adaptableInstance.api.optionsApi.getExportOptions();
     }
+    get logger() {
+        return this._adaptableInstance.logger;
+    }
     static getExcelClassNameForCell(colId, primaryKeyValue, userDefinedCellClass) {
         let excelClassName = `--excel-cell-${colId}-${primaryKeyValue}`;
         if (excelClassName.indexOf(' ') > 0) {
@@ -98,8 +101,7 @@ export class AgGridExportAdapter {
             };
         }
         catch (error) {
-            // FIXME AFL improve logging
-            console.error(error);
+            this.logger.consoleError(`Error exporting ${report.Name} in ${format} format to ${config.destination}`, error);
         }
         finally {
             /**

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: 1741253338614 || Date.now(),
-    VERSION: "20.0.0-canary.6" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1741274222010 || Date.now(),
+    VERSION: "20.0.0-canary.7" || '--current-version--',
 };