@adaptabletools/adaptable 23.0.4 → 23.0.5-canary.1

package/src/agGrid/AdaptableFilterHandler.js

@@ -12,7 +12,6 @@ export class AdaptableFilterHandler {
     doesFilterPass(params) {
         try {
             const rowNode = params.node;
-            // first assess if the Row is filterable - if not, then return true so it always appears in Grid
             const isRowFilterable = this.adaptableApi.gridApi.internalApi.isRowFilterable(rowNode);
             if (!isRowFilterable) {
                 return true;
@@ -64,9 +63,6 @@ export class AdaptableFilterHandler {
     onAnyFilterChanged() {
         const filterOptions = this.adaptableApi.optionsApi.getFilterOptions();
         if (!filterOptions.customInFilterValues) {
-            // no-one is using value.count or value.visible
-            // or context.sortedValues
-            // so no need to reset the filter display values
             return;
         }
         this.resetFilterDisplayValues();
@@ -75,7 +71,6 @@ export class AdaptableFilterHandler {
         if (this.filterDisplayValuesResult) {
             this.previousFilterDisplayValuesResult = this.filterDisplayValuesResult;
         }
-        // Reset the filter display values manually
         this.filterDisplayValuesResult = undefined;
     }
     async refreshFilterDisplayValues() {

package/src/agGrid/AdaptableLogger.js

@@ -19,9 +19,6 @@ export const warnOnce = (message) => {
     console.warn(message);
     warnOnceFlags[message] = true;
 };
-/**
- * AdapTable's Logger
- */
 export class AdaptableLogger {
     adaptableId;
     debugger;
@@ -30,7 +27,6 @@ export class AdaptableLogger {
     warnLogger;
     errorLogger;
     perfLogger;
-    // use static loggers whenever access to AdaptableLogger instance is not feasible
     static consoleErrorBase(message, ...optionalParams) {
         if (optionalParams?.length) {
             console.error(message, optionalParams);
@@ -164,8 +160,6 @@ export class AdaptableLogger {
         }
     }
 }
-// change the default colors a bit to remove
-// the dark blues that are hard to read on my monitor
 debugFactory.colors = [
     '#0033FF',
     '#0066CC',

package/src/agGrid/AgGridAdapter.js

@@ -9,19 +9,15 @@ import { isPivotGrandTotal } from '../Api/Implementation/ColumnApiImpl';
 import { isPivotColumnTotal } from '../layout-manager/src/isPivotColumnTotal';
 import { isPivotAggTotalColumn } from '../layout-manager/src/isPivotAggTotalColumn';
 import { ONLY_AGG_FN_NAME, WEIGHTED_AVERAGE_AGG_FN_NAME, } from '../AdaptableState/Common/AggregationColumns';
-// AG GRID obfuscates its internals, this is (currently) the best way to get hold of its internal services
 const DANGER_AG_GRID_BEANS_MAP = {};
 const getColumnApiModule = () => ColumnApiModule;
 export class AgGridAdapter {
     _adaptableInstance;
     DANGER_USE_GETTER_gridApi;
     DANGER_gridApi_from_args;
-    // see #gridOpts_monkey_patch
     DANGER_updateGridOptionsMonkeyPatcher;
-    // see #aggColumnFilters_monkey_patch
     DANGER_doFiltersPassMonkeyPatcher;
     DANGER_isAggFilterPresentMonkeyPatcher;
-    // see #aggFuncLabels_monkey_patch
     DANGER_getDefaultFuncLabelMonkeyPatcher;
     activePivotColumnFilters_MEMO = new WeakMap();
     initialGridOptions;
@@ -67,8 +63,6 @@ export class AgGridAdapter {
         return this._adaptableInstance.logger;
     }
     getActivePivotColumnFilters() {
-        // we memoize based on layout column filters object reference
-        // this method is called for each row during filtering so we need to optimize it
         const layoutColumnFilters = this.adaptableApi.layoutApi.internalApi.getCurrentLayout_perfOptimized()?.ColumnFilters;
         if (!layoutColumnFilters) {
             return [];
@@ -107,8 +101,6 @@ export class AgGridAdapter {
             console.error('AgGridApi is not available yet');
         }
     }
-    // #gridOpts_monkey_patch
-    // we need to intercept some of the GridOptions updates and refresh the Adaptable state
     monkeyPatchingGridOptionsUpdates() {
         const agGridOptionsService = this.DANGER_getPrivateAgGridBeans()?.gos;
         if (!agGridOptionsService) {
@@ -125,17 +117,13 @@ export class AgGridAdapter {
                     .getAgGridApi()
                     .getAllDisplayedColumns()
                     .map((col) => col.getColId());
-                // mark as hidden the colDefs of special columns which are not visible
                 self.patchColDefs(colDefsWithSpecialColumns, (colDef) => {
                     if (self.adaptableApi.columnApi.internalApi.isSpecialColumn(colDef.colId)) {
                         colDef.hide = !allDisplayedColIds.includes(colDef.colId);
                     }
                 });
-                // for pre-existing ColDefs, keep the filter property from the previous one
                 if (self.adaptableApi.optionsApi.getFilterOptions().useAdaptableFiltering) {
                     const hasActiveFilters = self.adaptableApi.filterApi.columnFilterApi.getActiveColumnFilters().length;
-                    // theoretically we should always update the filter property
-                    // practically, only do it if there are active filters to avoid unnecessary processing
                     if (hasActiveFilters) {
                         self.patchColDefs(colDefsWithSpecialColumns, (colDef) => {
                             if (colDef.filter !== false) {
@@ -150,20 +138,17 @@ export class AgGridAdapter {
                 options['columnDefs'] = colDefsWithSpecialColumns;
                 self.logger.info(`Added special columns on GridOptions.columnDefs update (source="${source}").`);
             }
-            // `context`
             const passedContext = options.context;
             if (passedContext) {
                 passedContext['__adaptable'] = self._adaptableInstance;
                 passedContext['adaptableApi'] = self.adaptableApi;
             }
-            // we mutated the options array, so it's OK to use the 'arguments' object
             GridOptionsService_updateGridOptions.apply(this, arguments);
         };
         agGridOptionsService.updateGridOptions = this.DANGER_updateGridOptionsMonkeyPatcher;
     }
     monkeyPatchingAggColumnFilters() {
         if (!this.adaptableApi.optionsApi.getFilterOptions().useAdaptableFiltering) {
-            // monkey patching is only needed if Adaptable is used for filtering
             return;
         }
         const agGridColumnFilterService = this.DANGER_getPrivateAgGridBeans()?.colFilter;
@@ -172,19 +157,12 @@ export class AgGridAdapter {
             return;
         }
         const self = this;
-        // https://github.com/ag-grid/ag-grid/blob/8409e99c8010473356a878e9bdfb836a5ea16718/packages/ag-grid-community/src/filter/columnFilterService.ts#L240
-        // monkey patch ColumnFilterService.doAggregateFiltersPass because currently Adaptable does NOT override the ColumnFilters
-        // (it uses the `doesExternalFilterPass` to evaluate the filters on the client side)
-        // #doAggregateFiltersPassMonkeyPatcher
         const original_doFilterPass = agGridColumnFilterService.doFiltersPass;
         this.DANGER_doFiltersPassMonkeyPatcher = function (rowNode, colIdToSkip, targetAggregates) {
             if (!targetAggregates) {
-                // if targetAggregates is not set, we are not in the aggregation phase
-                // so we can use the original doFiltersPass
                 return original_doFilterPass.call(this, rowNode, colIdToSkip);
             }
             if (!self.adaptableApi.layoutApi.isCurrentLayoutPivot()) {
-                // should NEVER happen
                 return true;
             }
             const pivotColumnFilters = self.getActivePivotColumnFilters();
@@ -195,7 +173,6 @@ export class AgGridAdapter {
                         if (!columnFilterEvaluationResult) {
                             return false;
                         }
-                        // else continue to next filter
                     }
                 }
             }
@@ -211,7 +188,6 @@ export class AgGridAdapter {
         };
         agGridColumnFilterService.isAggFilterPresent = this.DANGER_isAggFilterPresentMonkeyPatcher;
     }
-    // #aggFuncLabels_monkey_patch
     monkeyPatchingAggFuncLabels() {
         const agGridAggFuncService = this.DANGER_getPrivateAgGridBeans()?.aggFuncSvc;
         if (!agGridAggFuncService) {
@@ -239,11 +215,6 @@ export class AgGridAdapter {
         }
         return beans;
     }
-    // #sparkline_factory
-    // The AG Grid Sparklines module stores the `createSparkline` factory (sourced from
-    // `AgChartsEnterpriseModule`) in the registered `agSparklineCellRenderer` default params.
-    // We read it straight from the registry bean so Adaptable can render standalone sparkline
-    // previews without taking a direct dependency on `ag-charts-enterprise`.
     DANGER_getCreateSparkline() {
         const registry = this.DANGER_getPrivateAgGridBeans()?.registry;
         const sparklineComponent = registry?.getUserComponent('agSparklineCellRenderer', 'agSparklineCellRenderer');
@@ -255,11 +226,6 @@ export class AgGridAdapter {
     getAgGridRootElement() {
         return this.DANGER_getPrivateAgGridBeans()?.eGridDiv;
     }
-    /**
-     * When AG Grid is rendered the first time, the AG GridApi is not yet set in the Adaptable context (as it's set only AFTER the grid is fully initialised)
-     * yet we need it when evaluating custom GridOptions properties on the first render.
-     * to handle this edge case, we try to extract the AG GridApi from the invocation arguments
-     */
     grabAgGridApiOnTheFly(args) {
         if (this.DANGER_USE_GETTER_gridApi || this.DANGER_gridApi_from_args) {
             return;
@@ -267,7 +233,6 @@ export class AgGridAdapter {
         if (Array.isArray(args) &&
             args[0] &&
             typeof args[0].api === 'object' &&
-            // can't ise instanceof operator because gridApi is exported as interface
             typeof args[0].api?.getGridId === 'function') {
             this.DANGER_gridApi_from_args = args[0].api;
         }
@@ -314,25 +279,17 @@ export class AgGridAdapter {
         const mapColDefs = (colDefs) => {
             return colDefs.map((colDef) => {
                 if (this._adaptableInstance.agGridColumnAdapter.isColGroupDef(colDef)) {
-                    // if it's a group column, recursively map its children
                     colDef.children = mapColDefs(colDef.children);
                     return colDef;
                 }
                 else {
                     if (!isSpecialColDef(colDef)) {
-                        // if it's not a special column, return it as is
-                        // without a minWidth, columns in details grid are VERY wide
-                        // so the line below fixes https://github.com/AdaptableTools/adaptable/issues/2559
                         return { minWidth: 10, ...colDef };
                     }
                     const newlyCreatedSpecialColDef = specialColDefs.find((specialColDef) => specialColDef.colId === colDef.colId);
                     if (newlyCreatedSpecialColDef) {
-                        // if it's a special column and we have a special col def for it, return the special col def
                         processedSpecialColDefIds.push(colDef.colId);
-                        // merge the user defined colDef with the special col def
-                        // this way the user may provide some custom settings for the special col def (tooltip, etc)
                         const mergedColDef = {
-                            // see above comment for minWidth
                             minWidth: 10,
                             ...colDef,
                             ...newlyCreatedSpecialColDef,
@@ -340,24 +297,19 @@ export class AgGridAdapter {
                         return mergedColDef;
                     }
                     else {
-                        // otherwise, return the original col def
                         return colDef;
                     }
                 }
             });
         };
         let resultColDefs = mapColDefs(agGridColDefs);
-        // check if there are any special colDefs that were not processed
-        // in that case, add them to the end of the colDefs
         specialColDefs.forEach((specialColDef) => {
             if (!processedSpecialColDefIds.includes(specialColDef.colId)) {
                 resultColDefs.push(specialColDef);
             }
         });
-        // remove special column that are no longer defined
         resultColDefs = resultColDefs.filter((colDef) => {
             if (isSpecialColDef(colDef)) {
-                // must be in specialColDefs
                 return specialColDefs.some((specialColDef) => specialColDef.colId === colDef.colId);
             }
             return true;
@@ -378,13 +330,11 @@ export class AgGridAdapter {
         const selected = this.getAgGridApi().getCellRanges();
         const columns = [];
         const gridCells = [];
-        // we iterate for each ranges
         selected.forEach((rangeSelection) => {
             let shouldIncludeRange = true;
             if (rangeSelection.startRow && rangeSelection.endRow) {
                 let isStartRowPin = rangeSelection.startRow.rowPinned != null;
                 let isEndRowPin = rangeSelection.endRow.rowPinned != null;
-                // Warn user if trying to select pinned rows and if only selecting them, stop
                 if (isStartRowPin) {
                     if (isEndRowPin) {
                         shouldIncludeRange = false;
@@ -403,8 +353,6 @@ export class AgGridAdapter {
                             }
                             for (let rowIndex = y1; rowIndex <= y2; rowIndex++) {
                                 const rowNode = this.getAgGridApi().getDisplayedRowAtIndex(rowIndex);
-                                // we used NOT to return grouped rows but I think that was wrong - if someone wants to return them then that is up to them...
-                                // we definitely dont return pinned rows as they cannot be selected
                                 if (rowNode && !this.isPinnedRowNode(rowNode)) {
                                     const selectedCell = this.adaptableApi.gridApi.getGridCellFromRowNode(rowNode, colId);
                                     gridCells.push(selectedCell);
@@ -425,7 +373,6 @@ export class AgGridAdapter {
         const nodes = this.getAgGridApi().getSelectedNodes();
         const selectedRows = [];
         if (this._adaptableInstance.isInPivotMode()) {
-            //  dont perform row selection in pivot mode
             return undefined;
         }
         if (ArrayExtensions.IsNotNullOrEmpty(nodes)) {
@@ -494,7 +441,6 @@ export class AgGridAdapter {
             friendlyName =
                 customFriendlyName ??
                     (isFdc3MainActionColumn ? ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME : displayName);
-            // Add Column Group;s friendlyname to the Column Friendly Name if its in a legitimate Column Group
             if (this.adaptableOptions.columnOptions.addColumnGroupToColumnFriendlyName &&
                 ColumnGroup &&
                 ColumnGroup.columnGroupId !== ColumnGroup.friendlyName) {
@@ -524,8 +470,8 @@ export class AgGridAdapter {
             fieldOnly: isGenerated ? false : this.isColumnFieldonly(colDef),
             sortable: isGenerated ? false : this.isColumnSortable(colDef),
             filterable: this.isColumnFilterable(colDef),
-            queryable: true, // override later when we have the column object
-            exportable: true, // override later when we have the column object
+            queryable: true,
+            exportable: true,
             groupable: isGenerated ? false : this.isColumnRowGroupable(colDef),
             pivotable: isGenerated ? false : this.isColumnPivotable(colDef),
             aggregatable: isGenerated ? false : this.isColumnAggregetable(colDef),
@@ -568,7 +514,6 @@ export class AgGridAdapter {
         return Array.isArray(userAllowed) ? [...userAllowed] : undefined;
     }
     deriveAdaptableColumnDataType(agColumn, logWarning = true) {
-        // Some columns can have no ID or Title. we return string as a consequence but it needs testing
         if (!agColumn) {
             this.logger.warn('Column is undefined. Defaulting data type to "text".');
             return 'text';
@@ -596,32 +541,15 @@ export class AgGridAdapter {
             return 'unknown';
         }
         let dataType = 'unknown';
-        // check for colDef dataType
         const colDefDataType = agColumn.getColDef().cellDataType;
         if (typeof colDefDataType === 'string' && ALL_ADAPTABLE_DATA_TYPES.includes(colDefDataType)) {
             return colDefDataType;
         }
-        // see #agGridDataTypeDefinitions
-        // theoretically, if AG Grid was not able to infer the type, we should not be able to either
-        // but we give it a try, AG Grid is limited when the colDef has a valueGetter, valueParser, etc
-        // see https://www.ag-grid.com/javascript-data-grid/cell-data-types/#inferring-data-types
         let row = this.getAgGridApi().getDisplayedRowAtIndex(0);
         if (row == null) {
-            // possible that there will be no data.
             this.logger.consoleError(`No data in grid. Returning type "unknown" for column "${agColumn.getColId()}". This will affect features such as Filters and Column Formats.`);
             return 'unknown';
         }
-        // // if it's a group we need the content of the group
-        // if (row.group) {
-        //   const childNodes = row.childrenAfterGroup;
-        //   if (ArrayExtensions.IsNullOrEmpty(childNodes)) {
-        //     this.logger.consoleError(
-        //       `No data in grid, returning type "unknown" for Column: "${agColumn.getColId()}". This will impact several Adaptable features, such as Filters and ColumnFormats.`
-        //     );
-        //     return 'unknown';
-        //   }
-        //   row = childNodes[0];
-        // }
         const value = this._agGridApi_getValue(agColumn, row);
         switch (typeof value) {
             case 'string':
@@ -657,11 +585,9 @@ export class AgGridAdapter {
         if (!colDef) {
             return true;
         }
-        // if the column has conditional/dynamic editability, we assume some rows may be editable
         if (typeof colDef.editable === 'function') {
             return false;
         }
-        // otherwise we evaluate the colDef.editable property (columns are NOT editable by default)
         return !colDef.editable;
     }
     isColumnFieldonly(colDef) {
@@ -701,9 +627,7 @@ export class AgGridAdapter {
         const gridOptionsAggFuncs = this.adaptableApi.agGridApi.getGridOption('aggFuncs') || {};
         const gridOptionsAggFuncNames = Object.keys(gridOptionsAggFuncs);
         if (!hasAllowedAggFuncs) {
-            // we assume gridOptionsAggFuncNames includes 'weightedAvg' and 'only'
             const customAggFuncNames = gridOptionsAggFuncNames.filter((name) => name !== WEIGHTED_AVERAGE_AGG_FN_NAME && name !== ONLY_AGG_FN_NAME);
-            // 'weightedAvg' is displayed right after 'avg'
             const avgIndex = result.indexOf('avg');
             if (avgIndex >= 0) {
                 result.splice(avgIndex + 1, 0, WEIGHTED_AVERAGE_AGG_FN_NAME);
@@ -712,7 +636,6 @@ export class AgGridAdapter {
                 result.push(WEIGHTED_AVERAGE_AGG_FN_NAME);
             }
             result.push(...customAggFuncNames);
-            // 'only' is always the last element
             result.push(ONLY_AGG_FN_NAME);
         }
         return [...new Set(result)];
@@ -733,10 +656,7 @@ export class AgGridAdapter {
         return true;
     }
     isColumnQueryable(abColumn) {
-        return (
-            // !this.adaptableApi.columnApi.isPivotResultColumn(abColumn.columnId) &&
-            (this.adaptableApi.expressionApi.isColumnQueryable(abColumn))
-        );
+        return (this.adaptableApi.expressionApi.isColumnQueryable(abColumn));
     }
     isColumnExportable(abColumn) {
         return this.adaptableApi.exportApi.isColumnExportable(abColumn);
@@ -772,7 +692,6 @@ export class AgGridAdapter {
             isPivotAggTotalColumn(colDef));
     }
     isColumnFilterable(colDef) {
-        // follow agGrid logic which is that ONLY filterable if explicitly set
         if (this.adaptableApi.entitlementApi.getEntitlementAccessLevelForModule(ModuleConstants.ColumnFilterModuleId) == ACCESS_LEVEL_HIDDEN) {
             return false;
         }
@@ -792,7 +711,6 @@ export class AgGridAdapter {
                 : 'right'
             : false;
     }
-    // used for AG Grid when the column is FixedPinned, meaning it should never be unpinned
     isColumnFixed(colDef) {
         if (!colDef) {
             return false;
@@ -818,7 +736,6 @@ export class AgGridAdapter {
         return false;
     }
     isColumnSparkline(colDef) {
-        // see https://www.ag-grid.com/javascript-data-grid/sparklines-overview/#enabling-sparklines
         return colDef?.cellRenderer === 'agSparklineCellRenderer';
     }
     isVisibleNode(rowNode) {
@@ -840,9 +757,6 @@ export class AgGridAdapter {
         this.assignColumnIdsToColDefs(flattenedColDefs);
         return flattenedColDefs;
     }
-    /**
-     * Mutates the colDefs to ensure that each column has a colId
-     */
     assignColumnIdsToColDefs(colDefs = []) {
         const assignColId = (colDef) => {
             if (!colDef) {
@@ -884,7 +798,6 @@ export class AgGridAdapter {
         return colDefs.map(applyModification).filter(Boolean);
     }
     getDefaultColumnDefinition() {
-        // for early init phase, gridApi might not be ready yet
         return this.getAgGridApi(true)?.getGridOption('defaultColDef') ?? {};
     }
     _agGridApi_getValue(colKey, rowNode, gridApi) {