@adaptabletools/adaptable-cjs 18.0.0-canary.9 → 18.0.1

package/src/agGrid/AgGridAdapter.d.ts

@@ -1,9 +1,8 @@
-import { ColDef, Column, GridApi, GridOptions, IRowNode, ManagedGridOptionKey, ManagedGridOptions, Module, ModuleNames } from '@ag-grid-community/core';
+import { ColDef, ColGroupDef, Column, GridApi, GridOptions, IRowNode, ManagedGridOptionKey, ManagedGridOptions, Module, ModuleNames } from '@ag-grid-community/core';
 import { AdaptableAgGrid } from './AdaptableAgGrid';
 import { AdaptableColumn, AdaptableColumnGroup } from '../PredefinedConfig/Common/AdaptableColumn';
 import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../PredefinedConfig/Selection/SelectedRowInfo';
-import { ColGroupDef } from '@ag-grid-community/core/dist/esm/es6/entities/colDef';
 export declare class AgGridAdapter {
     private adaptableInstance;
     private DANGER_USE_GETTER_gridApi;
@@ -24,7 +23,9 @@ export declare class AgGridAdapter {
     grabAgGridApiOnTheFly(args: unknown): void;
     getLiveGridOptions(): GridOptions | undefined;
     updateGridOptions(options: ManagedGridOptions): void;
+    getGridOption<Key extends keyof GridOptions>(key: Key): GridOptions[Key];
     setGridOption<Key extends ManagedGridOptionKey>(key: Key, value: GridOptions[Key]): void;
+    getUserGridOptionsProperty<T extends keyof GridOptions>(propertyName: T): GridOptions[T];
     updateColumnFilterActiveState(): void;
     deriveSelectedCellInfoFromAgGrid(): SelectedCellInfo;
     deriveSelectedRowInfoFromAgGrid(): SelectedRowInfo;
@@ -59,4 +60,5 @@ export declare class AgGridAdapter {
      * Mutates the colDefs to ensure that each column has a colId
      */
     assignColumnIdsToColDefs(colDefs?: (ColDef | ColGroupDef)[]): void;
+    getDefaultColumnDefinition(): GridOptions['defaultColDef'];
 }

package/src/agGrid/AgGridAdapter.js

@@ -64,10 +64,17 @@ class AgGridAdapter {
         var _a;
         (_a = this.getAgGridApi()) === null || _a === void 0 ? void 0 : _a.updateGridOptions(options);
     }
+    getGridOption(key) {
+        var _a;
+        return (_a = this.getAgGridApi()) === null || _a === void 0 ? void 0 : _a.getGridOption(key);
+    }
     setGridOption(key, value) {
         var _a;
         (_a = this.getAgGridApi()) === null || _a === void 0 ? void 0 : _a.setGridOption(key, value);
     }
+    getUserGridOptionsProperty(propertyName) {
+        return this.adaptableInstance.agGridOptionsService.getUserGridOptionsProperty(propertyName);
+    }
     updateColumnFilterActiveState() {
         var _a;
         const columnFilters = this.adaptableApi.columnFilterApi.getActiveColumnFilters();
@@ -578,5 +585,10 @@ class AgGridAdapter {
         };
         colDefs.forEach((colDef) => assignColId(colDef));
     }
+    getDefaultColumnDefinition() {
+        var _a, _b;
+        // for early init phase, gridApi might not be ready yet
+        return (_b = (_a = this.getAgGridApi(true)) === null || _a === void 0 ? void 0 : _a.getGridOption('defaultColDef')) !== null && _b !== void 0 ? _b : {};
+    }
 }
 exports.AgGridAdapter = AgGridAdapter;

package/src/agGrid/AgGridColumnAdapter.d.ts

@@ -12,7 +12,6 @@ export declare class AgGridColumnAdapter {
     setColDefProperty<T extends keyof ColDef>(col: Column, propertyName: T, propertyGetter: (userPropertyValue: ColDef[T]) => ColDef[T] | undefined): void;
     getUserColDefProperty<T extends keyof ColDef>(columnId: string, propertyName: T): ColDef[T] | undefined;
     setupColumns(): void;
-    triggerSetupColumnKeyCreator(colId: string): void;
     private setupColumnValueGetter;
     private setupColumnCellClass;
     private setupColumnCellStyle;
@@ -21,7 +20,6 @@ export declare class AgGridColumnAdapter {
     private setupColumnTooltipValueGetter;
     private setupColumnQuickFilerText;
     private setupColumnAllowedAggFuncs;
-    private setupColumnKeyCreator;
     private setupColumnCellDataType;
     setupColumnHeader({ col, abColumn }: ColumnSetupInfo): boolean;
     private setupColumnFilter;
@@ -30,7 +28,7 @@ export declare class AgGridColumnAdapter {
     private setupColumnEditable;
     private setupColumnValueSetter;
     private setupColumnComparator;
-    private getExcelClassNameForCell;
+    getExcelClassNameForCell(colId: string, primaryKeyValue: any, userDefinedCellClass?: string | string[]): string;
     private isQuickSearchActive;
     private getEditableCellClass;
     private getReadonlyCellClass;

package/src/agGrid/AgGridColumnAdapter.js

@@ -9,13 +9,11 @@ const FloatingFilterWrapper_1 = require("./FloatingFilterWrapper");
 const StyleHelper_1 = require("../Utilities/Helpers/StyleHelper");
 const StringExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/StringExtensions"));
 const ObjectFactory_1 = require("../Utilities/ObjectFactory");
-const clamp_1 = tslib_1.__importDefault(require("lodash/clamp"));
 const tinycolor2_1 = tslib_1.__importDefault(require("tinycolor2"));
 const UIHelper_1 = tslib_1.__importDefault(require("../View/UIHelper"));
 const PercentBarRenderer_1 = require("./PercentBarRenderer");
 const BadgeRenderer_1 = require("./BadgeRenderer");
 const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
-const RowSummary_1 = require("../PredefinedConfig/Common/RowSummary");
 class AgGridColumnAdapter {
     constructor(adaptableInstance) {
         this.adaptableInstance = adaptableInstance;
@@ -106,24 +104,11 @@ class AgGridColumnAdapter {
             this.setupColumnHeader(colSetupInfo);
             this.setupColumnQuickFilerText(colSetupInfo);
             this.setupColumnAllowedAggFuncs(colSetupInfo);
-            this.setupColumnKeyCreator(colSetupInfo);
             // this is just to make sure that AG Grid does NOT infer the cellDataType
             // https://github.com/AdaptableTools/adaptable/issues/2230 should render it obsolete
             this.setupColumnCellDataType(colSetupInfo);
         });
     }
-    triggerSetupColumnKeyCreator(colId) {
-        const col = this.agGridApi.getColumn(colId);
-        const colDef = col.getColDef();
-        const abColumn = this.adaptableApi.columnApi.getColumnWithColumnId(colId);
-        const colSetupInfo = {
-            col,
-            colDef,
-            colId,
-            abColumn,
-        };
-        this.setupColumnKeyCreator(colSetupInfo);
-    }
     setupColumnValueGetter({ col }) {
         // need this here if we want plugins to intercept
         this.setColDefProperty(col, 'valueGetter', (userValue) => {
@@ -225,7 +210,7 @@ class AgGridColumnAdapter {
                     return (0, PercentBarRenderer_1.getPercentBarRendererForColumn)(styledColumn, abColumn, this.adaptableApi);
                 }
                 if (styledColumn.BadgeStyle) {
-                    return (0, BadgeRenderer_1.getBadgeRendererForColumn)(styledColumn, abColumn, this.adaptableApi);
+                    return (0, BadgeRenderer_1.getBadgeRendererForColumn)(styledColumn.BadgeStyle, abColumn, this.adaptableApi);
                 }
                 if (styledColumn.SparkLineStyle) {
                     return 'agSparklineCellRenderer';
@@ -291,36 +276,6 @@ class AgGridColumnAdapter {
             return abColumn.availableAggregationFunctions;
         });
     }
-    setupColumnKeyCreator(columnSetupInfo) {
-        const { col, abColumn } = columnSetupInfo;
-        const adaptableOptions = this.adaptableOptions;
-        this.setColDefProperty(col, 'keyCreator', (userPropertyValue) => {
-            return (params) => {
-                var _a;
-                if (typeof userPropertyValue === 'function') {
-                    return userPropertyValue(params);
-                }
-                const value = params.value;
-                if (this.adaptableInstance.agGridAdapter.getLiveGridOptions().groupAllowUnbalanced) {
-                    return value;
-                }
-                const balancedGroupsKey = (_a = adaptableOptions.groupingOptions) === null || _a === void 0 ? void 0 : _a.balancedGroupsKey;
-                if (!balancedGroupsKey) {
-                    return value;
-                }
-                let groupBalancedGroupsUnderKeyValue = typeof balancedGroupsKey === 'function'
-                    ? balancedGroupsKey({
-                        adaptableApi: this.adaptableApi,
-                        userName: this.adaptableOptions.userName,
-                        adaptableId: this.adaptableOptions.adaptableId,
-                        adaptableColumn: abColumn,
-                        params,
-                    })
-                    : balancedGroupsKey;
-                return value === null || value === undefined ? groupBalancedGroupsUnderKeyValue : value;
-            };
-        });
-    }
     setupColumnCellDataType(columnSetupInfo) {
         const { col } = columnSetupInfo;
         // AG Grid introduced since v30.x an inferred cellDataType
@@ -364,12 +319,19 @@ class AgGridColumnAdapter {
     setupColumnFloatingFilter({ col, colDef }) {
         const isFloatingFilterDisabled = !colDef.floatingFilter ||
             !this.adaptableOptions.columnFilterOptions.useAdaptableColumnFiltering;
+        this.adaptableOptions.columnFilterOptions.quickFilterOptions.showQuickFilter;
         this.setColDefProperty(col, 'floatingFilterComponent', () => {
             if (isFloatingFilterDisabled) {
                 return;
             }
             return (0, FloatingFilterWrapper_1.FloatingFilterWrapperFactory)(this.adaptableInstance);
         });
+        this.setColDefProperty(col, 'floatingFilter', (original_floatingFilter) => {
+            if (isFloatingFilterDisabled) {
+                return;
+            }
+            return (0, FloatingFilterWrapper_1.FloatingFilterWrapperFactory)(this.adaptableInstance);
+        });
         this.setColDefProperty(col, 'suppressFloatingFilterButton', () => {
             return !isFloatingFilterDisabled;
         });
@@ -390,19 +352,19 @@ class AgGridColumnAdapter {
                 const options = mostRelevantFormatColumn.DisplayFormat.Options;
                 if (mostRelevantFormatColumn.DisplayFormat.Formatter === 'NumberFormatter') {
                     // change the Number format - if the scope allows it
-                    if (this.adaptableApi.scopeApi.isColumnInNumericScope(abColumn, mostRelevantFormatColumn.Scope)) {
+                    if (this.adaptableApi.columnScopeApi.isColumnInNumericScope(abColumn, mostRelevantFormatColumn.Scope)) {
                         return this.adaptableApi.formatColumnApi.internalApi.getNumberFormattedValue(params.value, params.node, abColumn, options);
                     }
                 }
                 if (mostRelevantFormatColumn.DisplayFormat.Formatter === 'DateFormatter') {
                     // change the Date format - if the scope allows it
-                    if (this.adaptableApi.scopeApi.isColumnInDateScope(abColumn, mostRelevantFormatColumn.Scope)) {
+                    if (this.adaptableApi.columnScopeApi.isColumnInDateScope(abColumn, mostRelevantFormatColumn.Scope)) {
                         return this.adaptableApi.formatColumnApi.internalApi.getDateFormattedValue(params.value, params.node, abColumn, options);
                     }
                 }
                 if (mostRelevantFormatColumn.DisplayFormat.Formatter === 'StringFormatter') {
                     // change the String format - if the scope allows it
-                    if (this.adaptableApi.scopeApi.isColumnInStringsScope(abColumn, mostRelevantFormatColumn.Scope)) {
+                    if (this.adaptableApi.columnScopeApi.isColumnInStringsScope(abColumn, mostRelevantFormatColumn.Scope)) {
                         return this.adaptableApi.formatColumnApi.internalApi.getStringFormattedValue(params.value, params.node, abColumn, options);
                     }
                 }
@@ -420,7 +382,8 @@ class AgGridColumnAdapter {
             const cellEditableFn = this.adaptableOptions.editOptions.isCellEditable;
             const editableCallback = (params) => {
                 // Adaptable Row Summarie rows are not editable
-                if (params.node.data[RowSummary_1.ROW_SUMMARY_ROW_ID]) {
+                //        if (params.node.data[ROW_SUMMARY_ROW_ID]) {
+                if (this.adaptableApi.gridApi.isSummaryNode(params.node)) {
                     return false;
                 }
                 if (!cellEditableFn) {
@@ -444,7 +407,7 @@ class AgGridColumnAdapter {
             const preventEditAlertsForColumn = this.adaptableApi.alertApi.internalApi
                 .getAlertDefinitionsWithPreventEdit()
                 .filter((alertDefinition) => {
-                return this.adaptableApi.scopeApi.isColumnInScope(abColumn, alertDefinition.Scope);
+                return this.adaptableApi.columnScopeApi.isColumnInScope(abColumn, alertDefinition.Scope);
             });
             const noValidations = !preventEditAlertsForColumn.length && !((_a = this.adaptableOptions.editOptions) === null || _a === void 0 ? void 0 : _a.validateOnServer);
             if (noValidations) {
@@ -607,27 +570,27 @@ class AgGridColumnAdapter {
                     : undefined;
     }
     getNoteCellClassName(gridCell, params) {
-        if (!this.adaptableApi.internalApi.getModuleService().isModuleAvailable('Notes')) {
+        if (!this.adaptableApi.internalApi.getModuleService().isModuleAvailable('Note')) {
             return;
         }
-        if (!this.adaptableApi.notesApi.internalApi.areNotesAvailable()) {
+        if (!this.adaptableApi.noteApi.internalApi.areNotesSupported()) {
             return;
         }
         const cellPosition = {
             PrimaryKeyValue: gridCell.primaryKeyValue,
             ColumnId: gridCell.column.columnId,
         };
-        const cellNotes = this.adaptableApi.notesApi.getCellNotes(cellPosition);
-        if (!(cellNotes === null || cellNotes === void 0 ? void 0 : cellNotes.length)) {
+        const cellNote = this.adaptableApi.noteApi.getNoteForCell(cellPosition);
+        if (!cellNote) {
             return undefined;
         }
         return 'ab-Cell-Note';
     }
     getCommentCellClassName(gridCell, params) {
-        if (!this.adaptableApi.internalApi.getModuleService().isModuleAvailable('Comments')) {
+        if (!this.adaptableApi.internalApi.getModuleService().isModuleAvailable('Comment')) {
             return;
         }
-        if (!this.adaptableApi.commentApi.internalApi.areCommentsAvailable()) {
+        if (!this.adaptableApi.commentApi.internalApi.areCommentsSupported()) {
             return;
         }
         const position = {
@@ -645,7 +608,7 @@ class AgGridColumnAdapter {
             .map((formatColumn) => {
             var _a, _b;
             if (((_a = formatColumn.Style) === null || _a === void 0 ? void 0 : _a.ClassName) &&
-                this.adaptableApi.formatColumnApi.internalApi.isFormatColumnRelevantForColumn(formatColumn, abColumn, params)) {
+                this.adaptableApi.formatColumnApi.internalApi.formatColumnShouldRender(formatColumn, abColumn, params.node, params.value)) {
                 return (_b = formatColumn.Style) === null || _b === void 0 ? void 0 : _b.ClassName;
             }
         })
@@ -705,6 +668,7 @@ class AgGridColumnAdapter {
         return Object.assign(Object.assign({}, this.getFormatColumnCellStyle(gridCell.column, activeFormatColumnsWithStyle, params)), styledColumnStyle);
     }
     getStyledColumnStyle(styledColumn, abColumn, params) {
+        var _a;
         let style = {};
         const gradientStyle = styledColumn === null || styledColumn === void 0 ? void 0 : styledColumn.GradientStyle;
         if (params.value === undefined) {
@@ -712,18 +676,25 @@ class AgGridColumnAdapter {
         }
         let colValue = params.value;
         if (this.adaptableApi.gridApi.isGroupRowNode(params.node)) {
-            if (styledColumn.IncludeGroupedRows) {
-                const minColumnValue = this.adaptableApi.styledColumnApi.internalApi.getMinValueForNumericColumn(abColumn);
-                const maxColumnValue = this.adaptableApi.styledColumnApi.internalApi.getMaxValueForNumericColumn(abColumn);
-                /**
-                 * Color should always be in bounds, it should not overflow.
-                 * If the value is out of range, it shoul set the maximum/minimum color.
-                 */
-                colValue = (0, clamp_1.default)(params.value, minColumnValue, maxColumnValue);
-            }
-            else {
-                return style;
-            }
+            return style;
+            // if (styledColumn.IncludeGroupedRows) {
+            //   const minColumnValue =
+            //     this.adaptableApi.styledColumnApi.internalApi.getMinValueForNumericColumn(abColumn);
+            //   const maxColumnValue =
+            //     this.adaptableApi.styledColumnApi.internalApi.getMaxValueForNumericColumn(abColumn);
+            //   /**
+            //    * Color should always be in bounds, it should not overflow.
+            //    * If the value is out of range, it shoul set the maximum/minimum color.
+            //    */
+            //   colValue = clamp(params.value, minColumnValue, maxColumnValue);
+            // } else {
+            //   return style;
+            // }
+        }
+        if (styledColumn.BadgeStyle &&
+            !((_a = styledColumn.BadgeStyle.RowScope) === null || _a === void 0 ? void 0 : _a.ExcludeSummaryRows) &&
+            this.adaptableApi.gridApi.isSummaryNode(params === null || params === void 0 ? void 0 : params.node)) {
+            return style;
         }
         if (gradientStyle) {
             const min = this.adaptableApi.styledColumnApi.internalApi.getNumericStyleMinValue(styledColumn, abColumn, params.node, colValue);
@@ -763,7 +734,7 @@ class AgGridColumnAdapter {
             return {};
         }
         const relevantFormatColumnsWithStyle = activeFormatColumnsWithStyle.filter((formatColumn) => {
-            return this.adaptableApi.formatColumnApi.internalApi.isFormatColumnRelevantForColumn(formatColumn, abColumn, params);
+            return this.adaptableApi.formatColumnApi.internalApi.formatColumnShouldRender(formatColumn, abColumn, params.node, params.value);
         });
         return this.getFormatColumnAdaptableStyle(relevantFormatColumnsWithStyle);
     }

package/src/agGrid/AgGridMenuAdapter.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableAgGrid } from './AdaptableAgGrid';
-import { Column, GetContextMenuItems, GetContextMenuItemsParams, GetMainMenuItems, GetMainMenuItemsParams, MenuItemDef } from '@ag-grid-community/core';
+import { GetContextMenuItems, GetContextMenuItemsParams, GetMainMenuItems, GetMainMenuItemsParams, MenuItemDef } from '@ag-grid-community/core';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem, ColumnMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
 export declare class AgGridMenuAdapter {
     private adaptableInstance;
     constructor(adaptableInstance: AdaptableAgGrid);
@@ -9,20 +9,37 @@ export declare class AgGridMenuAdapter {
     private get adaptableApi();
     destroy(): void;
     buildColumnMenu(params: GetMainMenuItemsParams, originalGetMainMenuItems: GetMainMenuItems): (string | MenuItemDef)[];
-    buildStructuredAdaptableColumnItems(menuContext: ColumnMenuContext): {
-        adaptableMenuItems: AdaptableMenuItem[];
-        structuredAdaptableMenuItems: AdaptableMenuItem[];
-    };
     buildContextMenu(params: GetContextMenuItemsParams, originalGetContextMenuItems: GetContextMenuItems): (string | MenuItemDef)[];
-    createColumnMenuContextObject(adaptableColumn: AdaptableColumn, agGridColumn: Column): ColumnMenuContext;
+    private mapAgGridItemTypeToAgGridMenuItem;
+    private removeConsecutiveSeparators;
+    private createColumnMenuContextObject;
     private createAdaptableContextMenuItems;
     private createContextMenuContextObject;
     private mapAdaptableMenuItemToAgGridMenuDefinition;
     private mapCustomMenuItemToAgGridMenuDefinition;
     private mapUserMenuItemToAgGridMenuDefinition;
-    private buildGroupedModuleItems;
+    private buildContextMenuDefaultStructure;
+    /**
+     * Hide menu group with no subitems or elevate single subitem to parent level
+     */
+    private normalizeMenuGroup;
+    /**
+     * Default strategy for menu items: return as is if there is only one item, otherwise group them under a parent item
+     */
+    private getModuleSpecificStructure;
+    private getExportContextMenuStructure;
+    private getLayoutContextMenuStructure;
+    private buildMenuGroupParent;
+    private buildColumnMenuDefaultStructure;
+    private getColumnFilterColumnMenuStructure;
+    private getLayoutColumnMenuStructure;
+    private getStyledColumnColumnMenuStructure;
     private mapAdaptableMenuItemToSystemMenuItems;
     private createAdaptableColumnMenuItems;
     private mapAdaptableIconToAgGridIcon;
+    /**
+     * The output of this function is used to build the column header menu if the AG Grid Menu Module is NOT present
+     * This is controlled by the AdaptableAgGrid.embedColumnMenu property
+     */
     buildStandaloneColumnHeader(adaptableColumn: AdaptableColumn): AdaptableMenuItem[];
 }