@adaptabletools/adaptable-cjs 23.0.4 → 23.0.5-canary.1

package/src/Api/Implementation/AlertApiImpl.js

@@ -47,29 +47,21 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         return this.getAlertDefinitionById(alertDefinition.Uuid);
     }
     async displayAdaptableAlert(alertToShow) {
-        // There are 3 things we always do with an alert:
-        // 1. Dispatch the Alert (so it appears in the toolbar)
         this.addUidToAdaptableObject(alertToShow);
         this.dispatchAction(InternalRedux.AdaptableAlertAdd(alertToShow, this.getAlertOptions().maxAlertsInStore));
-        // 2. Publish the Alert Fired Event
         this.getEventApi().internalApi.fireAlertFiredEvent(alertToShow);
-        // 3. Manage the many different possible Alert behaviours
-        // Note:  alertProperties.PreventEdit is handled separately, in the Adaptable.setupColumnValueSetter() function
         if (alertToShow.alertDefinition?.AlertProperties != undefined) {
             const alertDefinition = alertToShow.alertDefinition;
             const presentationProperties = alertDefinition.AlertProperties;
-            // Show a Toast Popup
             if (presentationProperties.DisplayNotification) {
                 this.displayAdaptableAlertNotification(alertToShow);
             }
-            // Log to console
             if (presentationProperties.LogToConsole) {
                 this.getAdatableLogger().consoleLogByMessageType(alertToShow.header + ': ' + alertToShow.message, alertDefinition.MessageType);
             }
             if (presentationProperties.DisplaySystemStatusMessage) {
                 this.getSystemStatusApi().setSystemStatus(alertToShow.header, alertDefinition.MessageType, alertToShow.message);
             }
-            // Show Alert in a Div (if one has been set)
             if (presentationProperties.ShowInDiv) {
                 const alertDiv = (0, resolveContainerElement_1.resolveContainerElement)(this.getContainerOptions().alertContainer, this.getAdaptableInternalApi().buildBaseContext());
                 if (alertDiv) {
@@ -81,13 +73,11 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                 return;
             }
             const alertProperties = alertDefinition.AlertProperties ?? {};
-            // Jump to the Cell
             if (alertProperties.JumpToCell &&
                 (0, AdaptableAlert_1.isAdaptableCellChangedAlert)(alertToShow) &&
                 alertToShow.cellDataChangedInfo) {
                 this.getGridApi().jumpToCell(alertToShow.cellDataChangedInfo.primaryKeyValue, alertToShow.cellDataChangedInfo.column.columnId, alertToShow.cellDataChangedInfo.rowNode);
             }
-            // Jump to the Row
             else if (alertProperties.JumpToRow &&
                 (0, AdaptableAlert_1.isAdaptableRowChangedAlert)(alertToShow) &&
                 alertToShow.rowDataChangedInfo?.rowTrigger === 'Add') {
@@ -96,8 +86,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     this.getGridApi().jumpToRow(firstRowNode);
                 }
             }
-            // For CellChanged Alerts either Highlight the cell or row
-            // for former - we just refresh the cells to trigger a re-evaluation of the Adaptable.setupColumn[Style/Class]
             if ((0, AdaptableAlert_1.isAdaptableCellChangedAlert)(alertToShow) &&
                 alertToShow.cellDataChangedInfo &&
                 (alertProperties.HighlightCell || alertProperties.HighlightRow)) {
@@ -120,7 +108,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     }
                 }
             }
-            // For RowChange Alerts only Highlight the row - we just refresh the rows to trigger a re-evaluation of the Adaptable.setupColumn[Style/Class]
             else if (alertProperties.HighlightRow &&
                 (0, AdaptableAlert_1.isAdaptableRowChangedAlert)(alertToShow) &&
                 alertToShow.rowDataChangedInfo?.rowTrigger === 'Add') {
@@ -185,8 +172,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             if (this.getColumnScopeApi().scopeIsAll(alertDefinition.Scope) &&
                 !this.getExpressionApi().getAdaptableQueryExpression(alertDefinition.Rule)) {
-                // we don't support scope ALL without an expression
-                // the predicates for scope ALL do NOT make any sense for a programmatic evaluation
                 return false;
             }
             return true;
@@ -204,7 +189,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             const alertDefinitions = this.internalApi
                 .getAlertDefinitionsForCellDataChange(cellDataChangedInfo)
                 .filter((alertDefinition) => filterScopeAllDefinitions(alertDefinition))
-                // some alert definitions might NOT be relevant for the given locator
                 .filter((alertDefinition) => relevantAlertDefinitions.some((relevantAlertDefinition) => relevantAlertDefinition.Uuid === alertDefinition.Uuid));
             this.getAlertApi().internalApi.showAlertForDefinitions(cellDataChangedInfo, alertDefinitions);
         });
@@ -219,19 +203,15 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
             return [];
         }
-        //  if there is an Expression defined, extract only the columns from there (in that case the Scope would be 'All' anyway)
-        // columns referenced in rule expression
         const ruleExpression = this.getExpressionApi().getAdaptableQueryExpression(alertDefinition.Rule);
         if (this.getColumnScopeApi().scopeIsAll(alertDefinition.Scope) &&
             StringExtensions_1.default.IsNotNullOrEmpty(ruleExpression)) {
-            // return only first referenced column (otherwise we would generate multiple alerts for the same row)
             const queryColumns = this.getAdaptableInternalApi()
                 .getQueryLanguageService()
                 .getColumnsFromExpression(ruleExpression);
             return queryColumns.length > 0 ? [queryColumns[0]] : [];
         }
         else {
-            // otherwise return all columns for given scope
             return this.getColumnScopeApi()
                 .getColumnsInScope(alertDefinition.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
@@ -239,7 +219,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     createCellDataChangeInfoStubs(relevantColumnIds) {
         const cellDataChangeInfos = [];
-        //const adaptable: IAdaptable = this.getAdaptableInternalApi().getAdaptableInstance();
         const relevantColumns = this.getColumnApi()
             .getColumnsWithColumnIds(relevantColumnIds)
             .filter(Boolean);

package/src/Api/Implementation/ApiBase.js

@@ -4,13 +4,8 @@ exports.ApiBase = void 0;
 const tslib_1 = require("tslib");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const Uuid_1 = require("../../AdaptableState/Uuid");
-// Base class for the Api - provides checking dispatching methods
 class ApiBase {
     _adaptable;
-    /**
-     * Constructor for all the api classes which simply takes and assigns an instance of Adaptable
-     * @param _adaptable core IAdaptable object - for INTERNAL USE ONLY and not part of public API
-     */
     constructor(_adaptable) {
         this._adaptable = _adaptable;
     }
@@ -35,14 +30,6 @@ class ApiBase {
     isAdapTableReady() {
         return this._adaptable.isReady;
     }
-    /**
-     * Base api helper method which ensure that Adaptable Object being used in the function is not null or undefined
-     *
-     * If it does not exist then we log an error and the api method should stop
-     * @param item AdaptableObject being checked
-     * @param name the name of the object if it has one (e.g. if its a search)
-     * @param type the actual type of the object being checked
-     */
     checkItemExists(item, name, type) {
         if (Helper_1.default.objectNotExists(item)) {
             this.logError(`No ${type} found with the name: ${name}`);
@@ -66,29 +53,18 @@ class ApiBase {
             : this.getLayoutApi().getCurrentLayout();
         return objectList.filter((objectItem) => this.getLayoutApi().internalApi.isObjectExtendedInLayout(objectItem, module, extendedLayout));
     }
-    /**
-     * Base api Helper method that dispatches a *Redux Action* to the Store
-     * @param action the Redux Action to be dispatched
-     */
     dispatchAction(action) {
         if (this._adaptable.isDestroyed) {
             return;
         }
         this._adaptable.adaptableStore.TheStore.dispatch(action);
     }
-    /**
-     * Returns the entire State from the Store
-     *
-     * This is a simple *getState()* call
-     */
     getAdaptableState() {
         return this.getAdaptableStore().TheStore.getState();
     }
     getAdaptableStore() {
         return this._adaptable.adaptableStore;
     }
-    // Add the Uuid to the object if not present;
-    // It's generally done in Redux also but no harm checking in Api also in case we missed it.
     addUidToAdaptableObject(adaptableObject) {
         if (!adaptableObject.Uuid) {
             adaptableObject.Uuid = (0, Uuid_1.createUuid)();

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -52,7 +52,6 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
                     .getCalculatedColumnExpressionService()
                     .createAggregatedScalarLiveValue(calculatedColumn);
             });
-            // refresh calculated columns
             const aggCalculatedColumnIds = aggregatedCalculatedColumns.map((calculatedColumn) => calculatedColumn.ColumnId);
             if (this.getLayoutApi().internalApi.isLayoutGrouped()) {
                 this.getGridApi().refreshGroupRowNodes();

package/src/Api/Implementation/ChartingApiImpl.js

@@ -10,9 +10,6 @@ const ChartingInternalApi_1 = require("../Internal/ChartingInternalApi");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const ChartHelper_1 = require("../../Utilities/Helpers/ChartHelper");
 class ChartingApiImpl extends ApiBase_1.ApiBase {
-    /**
-     * @internal
-     */
     internalApi;
     constructor(_adaptable) {
         super(_adaptable);

package/src/Api/Implementation/ColumnApiImpl.js

@@ -111,15 +111,6 @@ function getFriendlyNameForPivotResultColumn(columnId, agGridApi) {
             .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
             .join(' ')}`;
     }
-    // is quite consuming on performance
-    // we don't need it anyway because currently (20.0.7) we don't display Pivot Totals at all
-    // if (isPivotAggregationTotalColumn(columnId, agGridApi)) {
-    //   return `[Aggregation Total] ${columnId
-    //     .split('_')
-    //     .slice(2)
-    //     .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-    //     .join(' ')}`;
-    // }
     return `[Pivot] ${columnId
         .split('_')
         .slice(1)
@@ -127,7 +118,6 @@ function getFriendlyNameForPivotResultColumn(columnId, agGridApi) {
         .join(' ')}`;
 }
 function isPivotResultColumn(columnId) {
-    // put this here as there might be other indicators we are not aware of?
     return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_COLUMN);
 }
 function isPivotGrandTotal(columnId) {
@@ -145,7 +135,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     getUIAvailableColumns() {
         return this.getColumns().filter((c) => !c.isUIHiddenColumn &&
             !c.isGeneratedSelectionColumn &&
-            // currently (20.0.7) we don't display Pivot Totals in UI
             !c.isPivotTotalColumn);
     }
     getSpecialColumns() {
@@ -208,7 +197,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (!(0, LayoutHelpers_1.isPivotLayout)(currentLayout)) {
             return false;
         }
-        // When PivotColumns is empty, agg columns keep their original IDs
         if (currentLayout.PivotColumns?.length === 0) {
             return (currentLayout.PivotAggregationColumns?.some((agg) => agg.ColumnId === columnId) ?? false);
         }
@@ -254,7 +242,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (columnId == undefined) {
             return;
         }
-        // just return null if no columns rather than logging a warning - otherwise get lots at startup
         if (ArrayExtensions_1.default.IsNullOrEmpty(this.getColumns())) {
             return;
         }
@@ -366,7 +353,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getColumnIdForFriendlyName(friendlyName) {
         if (friendlyName.includes(GeneralConstants.MISSING_COLUMN)) {
-            return friendlyName.replace(GeneralConstants.MISSING_COLUMN, ''); // Ids should stay "pure"
+            return friendlyName.replace(GeneralConstants.MISSING_COLUMN, '');
         }
         const foundColumn = this.getColumns().find((c) => c.friendlyName === friendlyName);
         if (foundColumn) {
@@ -404,7 +391,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return !!this.getColumnWithColumnId(columnId, false);
     }
     getColumnWithFriendlyName(columnFriendlyName, logWarning = true) {
-        // just return null if no columns rather than logging a warning - otherwise get lots at startup
         if (ArrayExtensions_1.default.IsNullOrEmpty(this.getColumns())) {
             return null;
         }

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -139,13 +139,6 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
         const columnFilter = this.getColumnFilterForColumn(columnId);
         return columnFilter ? this.isColumnFilterActive(columnFilter) : false;
     }
-    /**
-     * Checks if a filter is applied. It is applied when:
-     * - has no inputs
-     * - has inputs and inputs have values
-     *
-     * @param filter
-     */
     isColumnFilterActive(filter) {
         if (!filter || !filter.Predicates?.length) {
             return false;
@@ -156,7 +149,6 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
         return filter.Predicates.some((predicate) => {
             const predicateDef = this.getPredicateApi().getPredicateDefById(predicate.PredicateId);
             if (ArrayExtensions_1.default.IsNull(predicateDef.inputs) &&
-                // In and NotIn predicates ave no inputs in the definition
                 !this.getPredicateApi().internalApi.IsInOrNotInPredicate(predicate)) {
                 return true;
             }
@@ -164,7 +156,6 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
             if (ArrayExtensions_1.default.IsEmpty(inputs)) {
                 return false;
             }
-            // all values in the array need to be non-empty (e.g. between has two values, [min, max])
             const allInputsHaveValues = inputs.every((value) => {
                 return value !== undefined && value !== null && value !== '';
             });

package/src/Api/Implementation/ColumnScopeApiImpl.js

@@ -11,7 +11,6 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
             return false;
         }
         if ('All' in scope) {
-            // do we need a true check here?
             return true;
         }
         if ('DataTypes' in scope) {
@@ -51,7 +50,6 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
             return 'Nothing';
         }
         if ('All' in scope) {
-            // do we need a true check here?
             return 'Columns: All';
         }
         if ('ColumnTypes' in scope) {
@@ -173,19 +171,15 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
         return undefined;
     }
     isColumnInNumericScope(column, scope) {
-        // if column is not even numeric then return false
         if (column == null || column == undefined || column.dataType !== 'number') {
             return false;
         }
-        // if no scope then return false
         if (scope == undefined) {
             return false;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('DataTypes' in scope && scope.DataTypes.includes('number')) {
             return true;
         }
@@ -196,19 +190,15 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
     isColumnInTextScope(column, scope) {
-        // if column is not even string then return false
         if (column == null || column == undefined || column.dataType !== 'text') {
             return false;
         }
-        // if no scope then return false
         if (scope == undefined) {
             return false;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('DataTypes' in scope && scope.DataTypes.includes('text')) {
             return true;
         }
@@ -219,19 +209,15 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
     isColumnInDateScope(column, scope) {
-        // if column is not even numeric then return false
         if (column == null || column == undefined || column.dataType !== 'date') {
             return false;
         }
-        // if no scope then return false
         if (scope == undefined) {
             return false;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
-        // check if the scope has ColumnIds and whether this column is contained
         if ('DataTypes' in scope && scope.DataTypes.includes('date')) {
             return true;
         }
@@ -242,8 +228,6 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
     isScopeInScope(a, b) {
-        // AFL: Scope:'All' for object 'a' is NOT handled
-        // this is probably wrong, but we will touch it when a bug is filed
         if ('All' in b) {
             return true;
         }
@@ -269,11 +253,9 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
             a.ColumnTypes.every((columnType) => b.ColumnTypes.includes(columnType))) {
             return true;
         }
-        // check if each colum in a has column types in b
         if ('ColumnIds' in a && 'ColumnTypes' in b) {
             const inScope = a.ColumnIds.every((columnId) => {
                 const column = this.getColumnApi().getColumnWithColumnId(columnId);
-                // check if at least one column-type is in scope
                 return column.columnTypes.some((columnColumnType) => b.ColumnTypes.includes(columnColumnType));
             });
             if (inScope) {
@@ -284,9 +266,6 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
     }
     createCellColorRangesForScope(scope) {
         const distinctColumnsValues = this.getGridApi().internalApi.getDistinctRawValuesForColumn(this.getSingleColumnInScope(scope));
-        // One neutral band by default — same gray as RangesComponent "Add New Range".
-        // Users who want a diverging negative/positive scale should use Zero Centred
-        // (Gradient) or add/split ranges manually.
         if (this.distinctColumnValuesAreEmpty(distinctColumnsValues)) {
             return [
                 {

package/src/Api/Implementation/DashboardApiImpl.js

@@ -127,7 +127,6 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
         }
     }
     getCurrentToolbars() {
-        // if hidden or collapsed return fasle
         if (this.getDashboardState().IsCollapsed == true || this.getDashboardState().IsHidden == true) {
             return [];
         }

package/src/Api/Implementation/EntitlementApiImpl.js

@@ -35,7 +35,6 @@ class EntitlementApiImpl extends ApiBase_1.ApiBase {
                     }
                 }
             }
-            // if still here then return their default Access Level
             return defaultAccessLevel;
         }
         return GeneralConstants_1.ACCESS_LEVEL_FULL;

package/src/Api/Implementation/ExportApiImpl.js

@@ -28,7 +28,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         return this.getReportByName(reportName);
     }
     getReportByName(reportName) {
-        // if system report then create
         if (this.internalApi.isSystemReport(reportName)) {
             return this.internalApi.createSystemReport(reportName);
         }
@@ -68,11 +67,9 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
             })
             : systemReportFormatsOption;
         return reportFormats.filter((format) => {
-            // JSON format doesn't support Master Detail Grid
             if (this.getGridApi().isMasterDetailGrid()) {
                 return format !== 'JSON';
             }
-            // PivotLayout & AllData can't be exported as VisualExcel
             if (this.getExportApi().getCurrentReportName() === GeneralConstants_1.ALL_DATA_REPORT &&
                 this.getLayoutApi().isCurrentLayoutPivot()) {
                 return format !== 'VisualExcel';
@@ -117,7 +114,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         return destinationItems;
     }
     getAllFormats() {
-        // FIXME AFL: add here custom formats when available
         return this.getAvailableSystemFormats();
     }
     getAllReports() {
@@ -217,7 +213,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         return this.getExportApi()
             .getAllExportDestinations()
             .filter((destination) => {
-            // can NOT export BLOBs to Clipboard
             if (reportFormat === 'Excel' || reportFormat === 'VisualExcel') {
                 return destination !== 'Clipboard';
             }
@@ -231,12 +226,10 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         }
         this.logInfo(`Start Export of ${reportName} in format ${format} to ${destination}`);
         const processExportResult = await this.processExport(report, format, destination);
-        // if FALSE, cancel export
         if (!processExportResult) {
             this.logInfo(`Cancel Export of ${reportName}`);
             return;
         }
-        // if TRUE, continue with standard export
         if (processExportResult === true) {
             const exportedReport = await this._adaptable.agGridExportAdapter.exportData({
                 report,
@@ -246,13 +239,11 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
                 customExportParams: exportConfig?.exportParams,
             });
             if (!exportedReport) {
-                // for destination 'Download' and format 'Excel', 'VisualExcel' or 'Csv', AG Grid handles the download as well
                 return;
             }
             this.internalApi.sendReportToDestination(exportedReport, report, format, destination);
         }
         else {
-            // in this case the user has returned a custom ExportResultData object
             const userProcessedExportResult = processExportResult;
             if (!userProcessedExportResult) {
                 this.logWarn(`Processing of Export ${reportName} to ${destination} returned null or undefined`);
@@ -270,7 +261,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         this.logInfo(`Start getting Report Data for ${reportName} in format ${format}`);
         const processExportResult = await this.processExport(report, format, 'Clipboard');
         let reportData;
-        // handle Export processing
         if (typeof processExportResult?.type === 'string') {
             reportData = processExportResult;
         }

package/src/Api/Implementation/ExpressionApiImpl.js

@@ -65,7 +65,6 @@ class ExpressionApiImpl extends ApiBase_1.ApiBase {
             return Array.from(new Set(columnIds));
         }
         catch (error) {
-            // defensive programing, this should happen only if someone botched Initial Adaptable State
             this.logWarn(`QueryApi.getColumnsFromExpressionInvalid received an invalid expression: ${expression}
                   Error: ${error}`);
             return [];

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -35,9 +35,6 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
             return undefined;
         }
         const formatColumn = formatColumns.find((fc) => fc.DisplayFormat != undefined);
-        // Resolve numeric preset names (e.g. 'Dollar') into the concrete
-        // AdaptableFormat object so external callers always receive a fully
-        // structured format.
         return formatColumn ? (0, AdaptableFormatPresets_1.resolveDisplayFormat)(formatColumn.DisplayFormat) : undefined;
     }
     getSuspendedFormatColumns(config) {

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -56,7 +56,6 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
                     })
                     : [];
                 storedValues.forEach((sv) => {
-                    // do summat
                     const isExistingPKValue = existingPKValues.find((epk) => epk == sv.PrimaryKey);
                     if (isExistingPKValue) {
                         if (replaceAction == 'Conflicting') {
@@ -70,7 +69,6 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
                         }
                     }
                     else {
-                        // no existing value so just add it
                         freeTextColumn.FreeTextStoredValues.push(sv);
                     }
                 });

package/src/Api/Implementation/GridApiImpl.js

@@ -26,10 +26,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().Internal;
     }
     loadGridData(dataSource) {
-        // we intentionally set an initial empty array,
-        // to prevent `cellchanged` events from being triggered for rows that have
-        // the same primary key with existing rows
-        // see #testprevent_cellchanged_event_on_load_grid_data
         this._adaptable.agGridAdapter.setGridOption('rowData', []);
         this._adaptable.setGridData(dataSource);
         const allRowNodes = this.getAllRowNodes();
@@ -106,11 +102,10 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return rowNodes;
     }
     undoCellEdit(cellDataChangedInfo) {
-        // for the reason of this hacky solution see the comments in DataService
         this.getAdaptableInternalApi().getDataService().logUndoChange(cellDataChangedInfo);
         const cellUpdateRequest = {
             columnId: cellDataChangedInfo.column.columnId,
-            newValue: cellDataChangedInfo.oldValue, // need old value as we are undoing
+            newValue: cellDataChangedInfo.oldValue,
             primaryKeyValue: cellDataChangedInfo.primaryKeyValue,
             rowNode: cellDataChangedInfo.rowNode,
         };
@@ -173,7 +168,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this._adaptable.applyFiltering();
     }
     clearFiltering() {
-        // slightly round the houses but we have to call ColumnFilterAPI as it does it properly
         this.getColumnFilterApi().clearColumnFilters();
     }
     getColumnSorts() {
@@ -272,7 +266,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             }
         }
         else {
-            // include all row
             this._adaptable.forAllRowNodesDo((rowNode) => {
                 isRowNodeInQuery(rowNode) && filteredRowNodes.push(rowNode);
             });
@@ -282,29 +275,21 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }
         let preapredGridCellRange = gridCellRange;
         if (!preapredGridCellRange) {
-            /**
-             * Select all rows and all columns
-             */
             const currentLayout = this.getLayoutApi().getCurrentLayout();
             preapredGridCellRange = {
                 columnIds: currentLayout.TableColumns,
             };
         }
-        // ranges of row with consecutive indexes
         const rowRanges = filteredRowNodes.reduce((acc, rowNode, index, collection) => {
-            // add start if there is none
             const prevRange = acc[acc.length - 1];
             if (prevRange.startNode === undefined) {
                 prevRange.startNode = rowNode;
             }
-            // add end if next is not consecutive
             const nextNode = collection[index + 1];
             if (nextNode && nextNode.rowIndex - 1 !== rowNode.rowIndex) {
                 prevRange.endNode = rowNode;
-                // start a new one
                 acc.push({});
             }
-            // if at the end close last range
             if (index === collection.length - 1) {
                 prevRange.endNode = rowNode;
             }
@@ -312,7 +297,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }, [{}]);
         let preparedClearSelection = clearSelection;
         rowRanges.forEach((range) => {
-            // clear only on first range selection
             this._adaptable.selectCells(preapredGridCellRange.columnIds, range.startNode, range.endNode, preparedClearSelection);
             preparedClearSelection = false;
         });
@@ -563,7 +547,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this._adaptable.redrawRows(rowNodes);
     }
     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.updateRowGroupsAndColumnGroupsExpandedState();
     }
@@ -571,7 +554,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this._adaptable.refreshGridHeader();
     }
     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)
         if (!gridCell || !gridCell.column || !gridCell.rowNode) {
             return false;
         }
@@ -579,7 +561,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             return false;
         }
         const agGridColumn = this.getColumnApi().internalApi.getAgGridColumnForAdaptableColumn(gridCell.column.columnId);
-        // this will invoke the colDef.editable callback where we check both AdapTable and AG Grid editability
         return agGridColumn?.isCellEditable(gridCell.rowNode);
     }
     isCellEdited(gridCell) {
@@ -700,7 +681,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             const newColDef = newColumnDefinitions.find((c) => c.colId === colDef.colId);
             return newColDef ? { ...colDef, ...newColDef } : colDef;
         });
-        // find out new columns which are not in the current column definitions
         const currentColIds = [];
         this._adaptable.agGridAdapter.traverseColDefs(currentColDefs, (colDef) => {
             currentColIds.push(colDef.colId);
@@ -730,7 +710,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     addAgGridColumnDefinition(newColumnDefinition) {
         const currentColDefs = this.getAgGridColumnDefs();
-        // just in case check of there is not already an existing column with the same id and eliminate it
         const sanitizedColDefs = this._adaptable.agGridAdapter
             .traverseColDefs(currentColDefs, (colDef) => {
             return colDef.colId === newColumnDefinition.colId ? null : colDef;

package/src/Api/Implementation/GridFilterApiImpl.js

@@ -30,8 +30,6 @@ class GridFilterApiImpl extends ApiBase_1.ApiBase {
         return gridFilter.Expression;
     }
     setGridFilterExpression(filter) {
-        // A blank / nullish expression has no meaningful AST and would otherwise
-        // explode the parser inside LayoutGridFilterSet. Treat it as "clear".
         if (filter == null || filter.trim() === '') {
             this.clearGridFilter();
             return;