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

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;

package/src/Api/Implementation/LayoutApiImpl.js

@@ -101,7 +101,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         const config = {
             includeLayoutNotExtendedObjects: true,
         };
-        // Alerts
         const alertExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'Alert';
         });
@@ -112,7 +111,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getAlertApi().addAlertDefinition(alertDefinition);
             }
         });
-        // Custom Sorts
         const customSortExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'CustomSort';
         });
@@ -123,7 +121,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getCustomSortApi().addCustomSort(customSort);
             }
         });
-        // Flashing Cells
         const flashingCellExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'FlashingCell';
         });
@@ -134,7 +131,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getFlashingCellApi().addFlashingCellDefinition(flashingCellDefinition);
             }
         });
-        // FormatColumns
         const formatColumnExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'FormatColumn';
         });
@@ -145,7 +141,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getFormatColumnApi().addFormatColumn(formatColumn);
             }
         });
-        // Plus Minus
         const plusMinusExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'PlusMinus';
         });
@@ -156,7 +151,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getPlusMinusApi().addPlusMinusNudge(plusMinusNudge);
             }
         });
-        // Schedule
         const exportExtensions = extendedLayoutInfo.Extensions.filter((e) => e.Module === 'Export');
         exportExtensions.forEach((le) => {
             const raw = le.Object;
@@ -168,7 +162,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                 this.getExportApi().addScheduledReport(schedule);
             }
         });
-        // StyledColumn
         const styledColumnExtensions = extendedLayoutInfo.Extensions.filter((e) => {
             return e.Module == 'StyledColumn';
         });
@@ -190,7 +183,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             includeLayoutNotExtendedObjects: false,
             extendedLayoutName: layoutName,
         };
-        // cannot see a better way than to go through this module by module...
         let extensions = [];
         this.getAlertApi()
             .getAlertDefinitions(config)
@@ -233,19 +225,16 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         };
     }
     cloneExtendedLayout(extendedLayoutToClone, layoutName) {
-        // first clone the underlying Layout
         const clonedLayout = this.cloneLayout(extendedLayoutToClone.Layout, layoutName);
         if (clonedLayout == false) {
             return false;
         }
-        // Alerts
         const alertExtensions = extendedLayoutToClone.Extensions.filter((e) => e.Module == 'Alert');
         alertExtensions.forEach((le) => {
             const alertDef = le.Object;
             alertDef.Tags?.push(layoutName);
             this.getAlertApi().editAlertDefinition(alertDef);
         });
-        // Custom Sorts
         const customSortExtensions = extendedLayoutToClone.Extensions.filter((e) => {
             return e.Module == 'CustomSort';
         });
@@ -254,7 +243,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             customSort.Tags?.push(layoutName);
             this.getCustomSortApi().editCustomSort(customSort);
         });
-        // Flashing Cells
         const flashingCellExtensions = extendedLayoutToClone.Extensions.filter((e) => {
             return e.Module == 'FlashingCell';
         });
@@ -263,14 +251,12 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             flashingCellDef.Tags?.push(layoutName);
             this.getFlashingCellApi().editFlashingCellDefinition(flashingCellDef);
         });
-        // FormatColumns
         const formatColumnExtensions = extendedLayoutToClone.Extensions.filter((e) => e.Module == 'FormatColumn');
         formatColumnExtensions.forEach((le) => {
             const formatCol = le.Object;
             formatCol.Tags?.push(layoutName);
             this.getFormatColumnApi().editFormatColumn(formatCol);
         });
-        // Plus Minus
         const plusMinusExtensions = extendedLayoutToClone.Extensions.filter((e) => {
             return e.Module == 'PlusMinus';
         });
@@ -279,7 +265,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             plusMinusNudge.Tags?.push(layoutName);
             this.getPlusMinusApi().editPlusMinusNudge(plusMinusNudge);
         });
-        // Export
         const exportCloneExtensions = extendedLayoutToClone.Extensions.filter((e) => e.Module === 'Export');
         exportCloneExtensions.forEach((le) => {
             const raw = le.Object;
@@ -289,7 +274,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             schedule.Tags?.push(layoutName);
             this.getExportApi().editScheduledReport(schedule);
         });
-        // Shortcut
         const shortCutExtensions = extendedLayoutToClone.Extensions.filter((e) => {
             return e.Module == 'Shortcut';
         });
@@ -298,7 +282,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             shortcut.Tags?.push(layoutName);
             this.getShortcutApi().editShortcut(shortcut);
         });
-        // StyledColumn
         const styledColumnExtensions = extendedLayoutToClone.Extensions.filter((e) => {
             return e.Module == 'StyledColumn';
         });
@@ -307,7 +290,6 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             styledColumn.Tags?.push(layoutName);
             this.getStyledColumnApi().editStyledColumn(styledColumn);
         });
-        // now create the new Extended Layout with the same extensions
         const extendedLayout = {
             Layout: clonedLayout,
             Extensions: extendedLayoutToClone.Extensions,

package/src/Api/Implementation/LayoutHelpers.js

@@ -35,12 +35,9 @@ function cleanupAdaptableObjectPrimitives(layout) {
     const l = layout;
     for (const key in l) {
         if (key === 'ColumnFilters') {
-            // we don't want to cleanup ColumnFilters
-            // as we rely on the Uuids for identifying the filters
             if (Array.isArray(l[key])) {
                 l[key].forEach((item) => {
                     if (typeof item === 'object') {
-                        // but we do want to cleanup further down - eg: predicates in the filter
                         for (const k in item) {
                             if (typeof item[k] === 'object') {
                                 (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInlineDeep)(item[k]);
@@ -56,11 +53,6 @@ function cleanupAdaptableObjectPrimitives(layout) {
         }
     }
 }
-/**
- * Compares 2 Layouts for equality
- * @param layout1 First Layout
- * @param layout2 Second Layout
- */
 const areLayoutsEqual = (layout1, layout2) => {
     if (!layout1 && !layout2) {
         return true;
@@ -93,7 +85,6 @@ const normalizePivotLayout = (pivotLayout) => {
 };
 exports.normalizePivotLayout = normalizePivotLayout;
 const errorOnceMessages = new Map();
-/** Clears module-scoped dedupe state when a new Adaptable instance starts (e.g. Playwright retries). */
 const resetLayoutHelperErrorOnceMessages = () => {
     errorOnceMessages.clear();
 };
@@ -187,7 +178,6 @@ const checkForDuplicateColumns = (layout) => {
             layout.TableColumns.reduce((acc, col) => {
                 acc[col] = (acc[col] || 0) + 1;
                 if (acc[col] > 1) {
-                    // if you change this message, make sure you also update the associated test error-on-duplicate-column.spec.ts
                     errorOnce(`Duplicate column "${col}" in layout "${layout.Name}"!`);
                 }
                 return acc;
@@ -409,9 +399,7 @@ const tableLayoutModelToTableLayout = (layoutModel) => {
     if (layoutModel.Ignore_OpenCharts) {
         tableLayout.OpenCharts = layoutModel.Ignore_OpenCharts;
     }
-    // if (layoutModel.RowGroupDisplayType) {
     tableLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType ?? 'single';
-    // }
     if (layoutModel.RowGroupedColumns) {
         tableLayout.RowGroupedColumns = layoutModel.RowGroupedColumns;
     }
@@ -437,7 +425,6 @@ const tableLayoutModelToTableLayout = (layoutModel) => {
         if ((layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'collapsed' ||
             layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'expanded') &&
             layoutModel.ColumnGroupValues.Values) {
-            // @ts-ignore
             tableLayout.ColumnGroupValues.ExceptionGroupKeys = layoutModel.ColumnGroupValues.Values;
         }
     }
@@ -574,13 +561,10 @@ const pivotLayoutModelToPivotLayout = (layoutModel) => {
         if ((layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'collapsed' ||
             layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'expanded') &&
             layoutModel.ColumnGroupValues.Values) {
-            // @ts-ignore
             pivotLayout.ColumnGroupValues.ExceptionGroupKeys = layoutModel.ColumnGroupValues.Values;
         }
     }
-    // if (layoutModel.RowGroupDisplayType) {
     pivotLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType ?? 'single';
-    // }
     if (layoutModel.RowSelection != null) {
         pivotLayout.RowSelection = layoutModel.RowSelection;
     }

package/src/Api/Implementation/NamedQueryApiImpl.js

@@ -32,7 +32,6 @@ class NamedQueryApiImpl extends ApiBase_1.ApiBase {
         if ((0, StringExtensions_1.IsNullOrEmptyOrWhiteSpace)(namedQuery?.Name)) {
             return { valid: false, message: 'A name is required for the Named Query.' };
         }
-        // check that there is no other existing named query with the same name
         const duplicate = this.getNamedQueries().find((q) => q.Name === namedQuery.Name && q.Uuid !== namedQuery.Uuid);
         if (duplicate) {
             return {