@adaptabletools/adaptable 20.2.3 → 20.2.5

package/package.json

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -212,7 +212,7 @@ export interface IAdaptable {
     getGroupRowNodes(config?: {
         filterFn?: (rowNode: IRowNode) => boolean;
     }): IRowNode[];
-    updateRowGroupsExpandedState(layout?: Layout): void;
+    updateRowGroupsAndColumnGroupsExpandedState(layout?: Layout): void;
     getRowsInViewport(): IRowNode[];
     isGroupRowNode(rowNode: IRowNode): boolean;
     isRowNodeVisible(rowNode: IRowNode): boolean;

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -24,7 +24,7 @@ export interface ExportOptions<TData = any> {
     /**
      * User-provided Report Destinations (in addition to those shipped in AdapTable)
      */
-    customDestinations?: CustomDestination[];
+    customDestinations?: CustomDestination[] | ((context: CustomDestinationsContext) => CustomDestination[]);
     /**
      * System Reports to use; leave unset for all, empty array for none
      *
@@ -104,7 +104,7 @@ export interface SystemReportNamesContext extends BaseContext {
      */
     defaultSystemReportNames: SystemReportName[];
     /**
-     * Name of the current Layout
+     * Name of current Layout
      */
     currentLayoutName: string;
 }
@@ -117,11 +117,11 @@ export interface SystemReportFormatsContext extends BaseContext {
      */
     defaultSystemReportFormats: SystemReportFormat[];
     /**
-     * Name of the current Layout
+     * Name of current Layout
      */
     currentLayoutName: string;
     /**
-     * Name of the current Report
+     * Name of current Report
      */
     currentReportName?: ReportNameType;
 }
@@ -130,19 +130,36 @@ export interface SystemReportFormatsContext extends BaseContext {
  */
 export interface SystemExportDestinationsContext extends BaseContext {
     /**
-     * Default System Report Formats
+     * Default System Export Destinations
      */
     defaultSystemExportDestinations: SystemExportDestination[];
     /**
-     * Name of the current Layout
+     * Name of current Layout
+     */
+    currentLayoutName: string;
+    /**
+     * Name of current Report
+     */
+    currentReportName?: ReportNameType;
+    /**
+     * Format of current Report
+     */
+    currentReportFormat?: ReportFormatType;
+}
+/**
+ * Context provided to `ExportOptions.customDestinations` callback
+ */
+export interface CustomDestinationsContext extends BaseContext {
+    /**
+     * Name of current Layout
      */
     currentLayoutName: string;
     /**
-     * Name of the current Report
+     * Name of current Report
      */
     currentReportName?: ReportNameType;
     /**
-     * Format of the current Report
+     * Format of current Report
      */
     currentReportFormat?: ReportFormatType;
 }

package/src/AdaptableState/Common/AggregationColumns.d.ts

@@ -7,7 +7,13 @@ export type AggregationColumnValue = string | true | WeightedAverageAggregation;
  * Defines an Aggregated Column in a Table Layout
  */
 export type TableAggregationColumns = {
+    /**
+     * The Column being Aggretated
+     */
     ColumnId: string;
+    /**
+     * The type of Aggregation
+     */
     AggFunc: AggregationColumnValue;
 }[];
 /**

package/src/AdaptableState/LayoutState.d.ts

@@ -80,12 +80,7 @@ export interface LayoutBase extends AdaptableObject {
      */
     AutoSizeColumns?: boolean;
     /**
-     * Position of the Grand Total Row in the Layout.
-     * @property {boolean | string} GrandTotalRow
-     * - 'top' | 'bottom' - Scrollable position at grid edges
-     * - 'pinnedTop' | 'pinnedBottom' - Fixed position at grid edges
-     * - true - Same as 'pinnedTop'
-     * - false/null - Hidden
+     * Position of the Grand Total Row in the Layout
      */
     GrandTotalRow?: 'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean;
 }
@@ -191,22 +186,28 @@ export type RowGroupValuesWithExceptionKeys = {
     RowGroupDefaultBehavior: 'expanded' | 'collapsed';
 } & XOR<{
     /**
-     * @deprecated - use GroupKeys instead. Layout.RowGroupValues.GroupKeys[] array allows you
-     * to configure the row group expand / collapse behaviour for each combination of row grouped columns.
+     * @deprecated - use GroupKeys instead which enables listing exceptions on a per Column basis
      */
     ExceptionGroupKeys?: any[][];
 }, {
     /**
-     * Allows you to configure the row group expand / collapse behaviour for each combination of row grouped columns.
-     * The default value is configured via RowGroupDefaultBehavior, but exceptions are configured by the GroupKeys array.
-     * Each item in the GroupKeys array is a an object with `RowGroupedColumns` and `ExceptionGroupKeys`. Those properties
-     * configure the collapse/expand exceptions for the specific row group columns.
+     * Configures Row Group Expand / Collapse behaviour together with per Column Exceptions
      */
-    GroupKeys?: {
-        RowGroupedColumns: string[];
-        ExceptionGroupKeys?: any[][];
-    }[];
+    GroupKeys?: GroupKeys[];
 }>;
+/**
+ * Enables setting Row Group behaviour with exceptions
+ */
+export interface GroupKeys {
+    /**
+     * Columns that are Row Grouped
+     */
+    RowGroupedColumns: string[];
+    /**
+     * Exceptions to default behaviour, provided as array or arrays
+     */
+    ExceptionGroupKeys?: any[][];
+}
 /**
  * Manages Column Group expand / collapse behaviour, including exceptions
  */

package/src/Api/ExportApi.d.ts

@@ -22,6 +22,10 @@ export interface ExportApi {
      * Retrieves available System Export Destinations (configured in Export Options)
      */
     getAvailableSystemDestinations(): SystemExportDestination[];
+    /**
+     * Retrieves available Custom Destinations (configured in Export Options)
+     */
+    getAvailableCustomDestinations(): CustomDestination[];
     /**
      * Retrieves name of currently selected Report
      */
@@ -60,11 +64,6 @@ export interface ExportApi {
      * Retrieves all Report Formats that are available
      */
     getAllFormats(): ReportFormatType[];
-    /**
-     * Retrieves all Custom Destinations from Export Options
-     * @returns custom destinations
-     */
-    getCustomDestinations(): CustomDestination[];
     /**
      * Retrieves Destination with the given name
      * @param destinationName destination to retrieve
@@ -120,10 +119,10 @@ export interface ExportApi {
      */
     updateReports(reports: Report[]): Report[];
     /**
-     * If the given destination is a Custom one
+     * If the given destination is a System one
      * @param destination destination to check
      */
-    isExportDestinationCustom(destinationName: ExportDestinationType): boolean;
+    isExportDestinationSystem(destinationName: ExportDestinationType): boolean;
     /**
      * Retrieves the Export Destinations that are supported for the given Report Format
      * @param reportFormat - report format to check
@@ -144,7 +143,7 @@ export interface ExportApi {
      * @param format - format of the report
      * @param destination - destination to export to
      * @param exportConfig - optional export configuration
-      */
+     */
     exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, exportConfig?: ExportConfig): Promise<void>;
     /**
      * Gets the data for the Report with the given Name in the given Format

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

@@ -19,6 +19,8 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getAvailableSystemReports(): SystemReportName[];
     getAvailableSystemFormats(): SystemReportFormat[];
     getAvailableSystemDestinations(): SystemExportDestination[];
+    getAvailableCustomDestinations(): CustomDestination[];
+    isExportDestinationSystem(destinationName: string): boolean;
     getAllExportDestinations(): ExportDestinationType[];
     getAllFormats(): ReportFormatType[];
     getAllReports(): Report[];
@@ -26,8 +28,6 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     clearReport(): void;
     selectFormat(reportFormat: ReportFormatType | null): void;
     clearFormat(): void;
-    getCustomDestinations(): CustomDestination[];
-    isExportDestinationCustom(destinationName: string): boolean;
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
     canExportToExcel(): boolean;
     canExportToCsv(): boolean;

package/src/Api/Implementation/ExportApiImpl.js

@@ -2,7 +2,7 @@ import * as ExportRedux from '../../Redux/ActionsReducers/ExportRedux';
 import { ApiBase } from './ApiBase';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
-import { ALL_DATA_REPORT, EMPTY_STRING, SYSTEM_EXPORT_DESTINATIONS, SYSTEM_REPORT_FORMATS, SYSTEM_REPORT_NAMES, VISUAL_EXCEL_FORMAT_REPORT, } from '../../Utilities/Constants/GeneralConstants';
+import { ALL_DATA_REPORT, CLIPBOARD_EXPORT_DESTINATION, DOWNLOAD_EXPORT_DESTINATION, EMPTY_STRING, SYSTEM_EXPORT_DESTINATIONS, SYSTEM_REPORT_FORMATS, SYSTEM_REPORT_NAMES, VISUAL_EXCEL_FORMAT_REPORT, } from '../../Utilities/Constants/GeneralConstants';
 export class ExportApiImpl extends ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
@@ -38,7 +38,7 @@ export class ExportApiImpl extends ApiBase {
         if (this.internalApi.isSystemDestination(destinationName)) {
             return destinationName;
         }
-        return this.getCustomDestinations().find((destination) => destination.name === destinationName);
+        return this.getAvailableCustomDestinations().find((destination) => destination.name === destinationName);
     }
     getAvailableSystemReports() {
         const systemReportNamesOption = this.getExportOptions().systemReportNames;
@@ -93,10 +93,26 @@ export class ExportApiImpl extends ApiBase {
             return true;
         });
     }
+    getAvailableCustomDestinations() {
+        const customDestinationsOption = this.getExportOptions().customDestinations;
+        const customDestinations = typeof customDestinationsOption === 'function'
+            ? customDestinationsOption({
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+                currentLayoutName: this.getLayoutApi().getCurrentLayoutName(),
+                currentReportName: this.getExportApi().getCurrentReportName(),
+                currentReportFormat: this.getExportApi().getCurrentReportFormat(),
+            })
+            : customDestinationsOption;
+        return customDestinations ?? [];
+    }
+    isExportDestinationSystem(destinationName) {
+        return (destinationName == DOWNLOAD_EXPORT_DESTINATION ||
+            destinationName == CLIPBOARD_EXPORT_DESTINATION);
+    }
     getAllExportDestinations() {
         const destinationItems = [
             ...this.getAvailableSystemDestinations(),
-            ...this.getCustomDestinations().map((destination) => destination.name),
+            ...this.getAvailableCustomDestinations().map((destination) => destination.name),
         ];
         return destinationItems;
     }
@@ -122,15 +138,8 @@ export class ExportApiImpl extends ApiBase {
     clearFormat() {
         this.selectFormat(null);
     }
-    getCustomDestinations() {
-        return this.getExportOptions().customDestinations ?? [];
-    }
-    isExportDestinationCustom(destinationName) {
-        return this.getCustomDestinations().some((destination) => destination.name === destinationName);
-    }
     getExportDestinationForm(destinationName) {
-        return this.getCustomDestinations().find((destination) => destination.name === destinationName)
-            ?.form;
+        return this.getAvailableCustomDestinations().find((destination) => destination.name === destinationName)?.form;
     }
     canExportToExcel() {
         return this._adaptable.canExportToExcel();

package/src/Api/Implementation/GridApiImpl.js

@@ -511,7 +511,7 @@ export class GridApiImpl extends ApiBase {
     refreshGroupRowNodes() {
         // see https://www.ag-grid.com/javascript-data-grid/client-side-row-stages/#refreshing-the-client-side-model
         this.getAgGridApi().refreshClientSideRowModel('group');
-        this._adaptable.updateRowGroupsExpandedState();
+        this._adaptable.updateRowGroupsAndColumnGroupsExpandedState();
     }
     isCellEditable(gridCell) {
         // If not Grid Cell or Column then return false - GridCell.column may be undefined for cells from synthetic columns created by AG Grid (ex. autoGroup columns)

package/src/Api/Internal/ExportInternalApi.js

@@ -209,7 +209,7 @@ export class ExportInternalApi extends ApiBase {
             this.logWarn(`No report result to send to destination for report '${report.Name}, format '${format}' and destination '${destination}'`);
             return;
         }
-        if (this.getExportApi().isExportDestinationCustom(destination)) {
+        if (!this.getExportApi().isExportDestinationSystem(destination)) {
             this.sendReportToCustomDestination(reportResult, report, format, destination);
         }
         if (destination === 'Download') {
@@ -232,9 +232,9 @@ export class ExportInternalApi extends ApiBase {
         }
     }
     sendReportToCustomDestination(reportResult, report, format, destination) {
-        const customDestination = this.getOptionsApi()
-            .getAdaptableOptions()
-            .exportOptions.customDestinations?.find((cd) => cd.name == destination);
+        const customDestination = this.getExportApi()
+            .getAvailableCustomDestinations()
+            .find((cd) => cd.name == destination);
         if (customDestination?.form) {
             this.getAdaptableInternalApi().dispatchReduxAction(PopupRedux.PopupShowForm({
                 Id: 'export-destination-form',

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -221,7 +221,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private addSyntheticPrimaryKeyIfMissing;
     getFirstDisplayedRowNode(): IRowNode;
     getFirstRowNode(): IRowNode | undefined;
-    updateRowGroupsExpandedState(layout?: Layout): void;
+    updateRowGroupsAndColumnGroupsExpandedState(layout?: Layout): void;
     isGroupRowNode(rowNode: IRowNode): boolean;
     getFilteredData(): any[];
     /**

package/src/agGrid/AdaptableAgGrid.js

@@ -1966,7 +1966,7 @@ You need to define at least one Layout!`);
             this.addSyntheticPrimaryKey(dataSource);
         }
         this.agGridAdapter.setGridOption('rowData', dataSource);
-        this.updateRowGroupsExpandedState();
+        this.updateRowGroupsAndColumnGroupsExpandedState();
         // this.updateColumnModelAndRefreshGrid();
     }
     getGridData() {
@@ -2009,12 +2009,13 @@ You need to define at least one Layout!`);
         }
         return firstRowNode;
     }
-    updateRowGroupsExpandedState(layout) {
+    updateRowGroupsAndColumnGroupsExpandedState(layout) {
         if (!layout) {
             layout = this.api.layoutApi.getCurrentLayout();
         }
         const layoutModel = layoutStateToLayoutModel(layout);
         this.layoutManager.applyRowGroupValues(layoutModel.RowGroupValues, layoutModel.RowGroupedColumns);
+        this.layoutManager.applyColumnGroupCollapseExpandState(layoutModel);
     }
     isGroupRowNode(rowNode) {
         if (!rowNode) {
@@ -2100,7 +2101,7 @@ You need to define at least one Layout!`);
                         dataUpdateConfig.callback(transaction);
                     }
                     resolve(transaction?.add);
-                    this.updateRowGroupsExpandedState();
+                    this.updateRowGroupsAndColumnGroupsExpandedState();
                 });
                 if (dataUpdateConfig.flushAsync) {
                     this.agGridAdapter.getAgGridApi().flushAsyncTransactions();
@@ -2112,7 +2113,7 @@ You need to define at least one Layout!`);
             if (dataUpdateConfig.flushAsync) {
                 this.agGridAdapter.getAgGridApi().flushAsyncTransactions();
             }
-            this.updateRowGroupsExpandedState();
+            this.updateRowGroupsAndColumnGroupsExpandedState();
             return Promise.resolve(transaction?.add);
         }
     }
@@ -2140,7 +2141,7 @@ You need to define at least one Layout!`);
                         dataUpdateConfig.callback(transaction);
                     }
                     if (transaction?.add) {
-                        this.updateRowGroupsExpandedState();
+                        this.updateRowGroupsAndColumnGroupsExpandedState();
                     }
                     resolve({
                         added: transaction?.add,
@@ -2159,7 +2160,7 @@ You need to define at least one Layout!`);
                 addIndex: dataUpdateConfig.addIndex,
             });
             if (transaction?.add) {
-                this.updateRowGroupsExpandedState();
+                this.updateRowGroupsAndColumnGroupsExpandedState();
             }
             if (dataUpdateConfig.flushAsync) {
                 this.agGridAdapter.getAgGridApi().flushAsyncTransactions();

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: 1750939303696 || Date.now(),
-    VERSION: "20.2.3" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1751286758695 || Date.now(),
+    VERSION: "20.2.5" || '--current-version--',
 };

package/src/layout-manager/src/index.js

@@ -223,21 +223,9 @@ export class LayoutManager extends LMEmitter {
         const shouldSkipTriggerChange = options?.skipTriggerChange === true;
         this._prevFiredLayout = layout;
         this.currentLayout = layout;
-        if ((!prevLayout?.RowGroupedColumns || !prevLayout?.RowGroupedColumns.length) &&
-            layout.RowGroupedColumns &&
-            layout.RowGroupedColumns.length > 0 &&
-            layout.RowGroupValues) {
-            // most likely the user has changed grouping via some AG Grid action
-            // and we need to make sure the expand/collapse state is applied
-            // but we want to suspend the listener
-            // as it would re-trigger another change
-            const unsupress = this.suspendAgGridListener();
-            this.applyRowGroupValues(layout.RowGroupValues, layout.RowGroupedColumns);
-            unsupress();
-        }
-        if ((!prevLayout?.RowGroupedColumns || !prevLayout?.RowGroupedColumns.length) &&
-            layout.RowGroupedColumns &&
+        if (layout.RowGroupedColumns &&
             layout.RowGroupedColumns.length > 0 &&
+            (prevLayout?.RowGroupedColumns || []).join(',') !== layout.RowGroupedColumns.join(',') &&
             layout.RowGroupValues) {
             // most likely the user has changed grouping via some AG Grid action
             // and we need to make sure the expand/collapse state is applied
@@ -473,12 +461,24 @@ export class LayoutManager extends LMEmitter {
             });
         }
         if (RowGroupedColumns && RowGroupedColumns.length) {
+            const LayoutRowGroupedColumns = this.currentLayout?.RowGroupedColumns || this.currentLayout?.PivotGroupedColumns || [];
             // if it's a new grouping, try and take it
-            const isGroupingNew = RowGroupedColumns &&
-                !this.currentLayout?.RowGroupedColumns &&
-                !this.currentLayout?.PivotGroupedColumns;
+            const isGroupingNew = RowGroupedColumns && RowGroupedColumns.join(',') !== LayoutRowGroupedColumns.join(',');
             if (this.currentLayout?.RowGroupValues) {
                 const currentRowGroupValues = this.currentLayout.RowGroupValues;
+                let currentRowGroupValuesGroupKeys = [];
+                if (currentRowGroupValues.RowGroupDisplay === 'expanded' ||
+                    currentRowGroupValues.RowGroupDisplay === 'collapsed') {
+                    if (Array.isArray(currentRowGroupValues.GroupKeys)) {
+                        currentRowGroupValuesGroupKeys =
+                            currentRowGroupValues.GroupKeys.find((item) => {
+                                return ((item.RowGroupedColumns || []).join(',') === (RowGroupedColumns || []).join(','));
+                            })?.Values || [];
+                    }
+                    else {
+                        currentRowGroupValuesGroupKeys = currentRowGroupValues.Values || [];
+                    }
+                }
                 if (currentRowGroupValues.RowGroupDisplay === 'always-collapsed') {
                     RowGroupValues = {
                         RowGroupDisplay: 'always-collapsed',
@@ -491,7 +491,7 @@ export class LayoutManager extends LMEmitter {
                 }
                 else if (currentRowGroupValues.RowGroupDisplay === 'collapsed') {
                     const ExpandedValues = isGroupingNew
-                        ? currentRowGroupValues.Values || []
+                        ? currentRowGroupValuesGroupKeys || []
                         : this.getRowGroupNodePathsAs({
                             expanded: true,
                         });
@@ -518,7 +518,7 @@ export class LayoutManager extends LMEmitter {
                 }
                 else if (currentRowGroupValues.RowGroupDisplay === 'expanded') {
                     const CollapsedValues = isGroupingNew
-                        ? currentRowGroupValues.Values || []
+                        ? currentRowGroupValuesGroupKeys || []
                         : this.getRowGroupNodePathsAs({
                             expanded: false,
                         });

package/src/metamodel/adaptable.metamodel.d.ts

@@ -2325,6 +2325,24 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt?: undefined;
         })[];
     };
+    CustomDestinationsContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        })[];
+    };
     CustomDisplayFormatter: {
         name: string;
         kind: string;
@@ -3855,6 +3873,22 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    GroupKeys: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+        })[];
+    };
     HandleFdc3Context: {
         name: string;
         kind: string;