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

package/src/Api/Internal/AlertInternalApi.js

@@ -27,67 +27,34 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
                     : undefined;
         return expression;
     }
-    /**
-     * Retrieves the Adaptable Form with the given name
-     * @param name name of the Form
-     */
     getAdaptableFormByName(name) {
         const alertForms = this.getAlertOptions().alertForms || [];
         return alertForms.find((f) => f.name === name)?.form;
     }
-    /**
-     * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns alert definitions
-     */
     getNonReactiveAlertDefinitions(config) {
         return this.getAlertApi()
             .getAlertDefinitions(config)
             .filter((alertDef) => (0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDef) &&
             !(0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
     }
-    /**
-     * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns alert definitions
-     */
     getActiveNonReactiveAlertDefinitions(config) {
         return this.getNonReactiveAlertDefinitions(config).filter((alertDef) => !alertDef.IsSuspended);
     }
-    /**
-     *
-     * Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns alert definitions
-     */
     getReactiveAlertDefinitions(config) {
         return this.getAlertApi()
             .getAlertDefinitions(config)
             .filter((alertDef) => (0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDef) &&
             (0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
     }
-    /**
-     *
-     * Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns alert definitions
-     */
     getActiveReactiveAlertDefinitions() {
         return this.getReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);
     }
-    /**
-     * Retrieves all Alert Definitions which prevent a Cell Edit
-     * @returns alert definitions
-     */
     getAlertDefinitionsWithPreventEdit(config) {
         return this.getActiveNonReactiveAlertDefinitions(config).filter((a) => a.AlertProperties != null && a.AlertProperties.PreventEdit === true);
     }
-    /**
-     * Retrieves all Alert Definitions which allow a Cell Edit
-     *  @returns alert definitions
-     */
     getAlertDefinitionsWithAllowEdit(config) {
         return this.getActiveNonReactiveAlertDefinitions(config).filter((a) => a.AlertProperties == null || a.AlertProperties.PreventEdit !== true);
     }
-    /**
-     * Runs after a button in an Alert Form is clicked
-     */
     executeAlertButton(button, context) {
         if (button.Command) {
             let commands = button.Command;
@@ -114,11 +81,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             });
         }
     }
-    /**
-     * Runs after an Alert Command is invoked
-     * @param command Action which has been invoked
-     * @param details Info about the Alert and Form
-     */
     executeAlertCommand(command, details) {
         const { alertDefinition, cellDataChangedInfo: cellDataChangedInfo, rowDataChangedInfo: rowDataChangedInfo, } = details;
         const getBackgroundColor = (alertDefinition) => {
@@ -162,7 +124,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         }
         if (command === 'highlight-row' &&
             rowDataChangedInfo &&
-            // no sense to highlight a deleted(non-existing) row
             rowDataChangedInfo?.rowTrigger !== 'Delete') {
             const primaryKeyValues = this.getGridApi().getPrimaryKeyValuesForRowNodes(rowDataChangedInfo.rowNodes);
             const rowsHighlightInfo = {
@@ -178,11 +139,8 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             this.getGridApi().jumpToCell(cellDataChangedInfo.primaryKeyValue, cellDataChangedInfo.column.columnId, cellDataChangedInfo.rowNode);
         }
         if (command === 'jump-to-row' &&
-            // either a cell change
             (cellDataChangedInfo ||
-                // or a grid change, but NOT row deletion
                 (rowDataChangedInfo &&
-                    // no sense to jump to a deleted(non-existing) row
                     rowDataChangedInfo?.rowTrigger !== 'Delete'))) {
             const [firstRowNode] = cellDataChangedInfo
                 ? [cellDataChangedInfo.rowNode]
@@ -202,19 +160,11 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             this.getGridApi().undoCellEdit(cellDataChangedInfo);
         }
     }
-    /**
-     * Retrieves all Predicate Defs that match given Scope
-     * @param scope the Scope to check
-     */
     getAlertPredicateDefsForScope(scope) {
         return this.getPredicateApi()
             .internalApi.getAlertPredicateDefs(scope)
             .filter((predicateDef) => this.getColumnScopeApi().isScopeInScope(scope, predicateDef.columnScope));
     }
-    /**
-     * Returns a description of an Alert Definition
-     * @param alertDefinition Alert Definition to use
-     */
     getAlertDescriptionForDataChange(alertDefinition, cellDataChangedInfo) {
         let customMessage = this.getCustomAlertDescription(alertDefinition, { cellDataChangedInfo });
         const anotationContext = cellDataChangedInfo
@@ -253,10 +203,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;
     }
-    /**
-     * Returns a description title of an Alert Definition
-     * @param alertDefinition Alert Definition to use
-     */
     getAlertMessageHeaderForDataChange(alertDefinition, cellDataChangedInfo) {
         const anotationContext = cellDataChangedInfo
             ? {
@@ -326,12 +272,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         }
         return header;
     }
-    /**
-     * Returns custom description for alert using the 'alertMessageText' property
-     *
-     * @param alertDefinition Alert Definition to use
-     * @param dataChangedInfo data change info, it can be eighter grid or cell data chantged info
-     */
     getCustomAlertDescription(alertDefinition, dataChangedInfo) {
         const alertMessageFunction = this.getAlertOptions()?.alertMessageText;
         if (alertMessageFunction) {
@@ -347,11 +287,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         }
         return null;
     }
-    /**
-     * Returns custom title defined by 'alertMessageHeader' property
-     * @param alertDefinition Alert Definition to use
-     * @param dataChangedInfo Data change info, it can be eighter grid or cell data chantged info
-     */
     getCustomAlertMessageHeader(alertDefinition, dataChangedInfo) {
         const alertMessageFunction = this.getAlertOptions()?.alertMessageHeader;
         if (alertMessageFunction) {
@@ -369,10 +304,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         }
         return null;
     }
-    /**
-     * Returns a description of an Alert Definition's Rule
-     * @param alertDefinition Alert Definition to use
-     */
     getAlertRuleDescription(alertDefinition) {
         if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
             return '';
@@ -382,31 +313,15 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             : this.getAdaptableInternalApi().getAdaptableQueryExpressionText(alertDefinition.Rule);
         return ruleDescription;
     }
-    /**
-     * Was Adaptable Alert fired due to a Cell Change
-     * @param alert AdaptableAlert to check
-     */
     isCellChangedAdaptableAlert(alert) {
         return alert.alertType === 'cellChanged';
     }
-    /**
-     * Was Adaptable Alert fired due to a Row Change
-     * @param alert AdaptableAlert to check
-     */
     isRowChangedAdaptableAlert(alert) {
         return alert.alertType === 'rowChanged';
     }
-    /**
-     * Is Adaptable Alert a Generic one
-     * @param alert AdaptableAlert to check
-     */
     isGenericAdaptableAlert(alert) {
         return alert.alertType === 'generic';
     }
-    /**
-     * Returns for the Alert Type for an Adaptable Alert
-     * @param alert AdaptableAlert to check
-     */
     getAlertTypeForAdaptableAlert(alert) {
         return alert.alertType;
     }
@@ -435,14 +350,12 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             return;
         }
         if (adaptableAlertForm && adaptableAlertForm.buttons) {
-            // dont mutate the form, but clone it
             adaptableAlertForm = { ...adaptableAlertForm };
             adaptableAlertForm.buttons = adaptableAlertForm.buttons?.map((button) => {
                 let buttonStyle = isActionForm
                     ? button.ButtonStyle
                     : this.getAdaptableInternalApi().getStyleForButton(button, context);
                 if (defaultMessageType && !buttonStyle?.tone) {
-                    // force the button tone to be the alert tone, if the tone is missing from button style (or button style non-existent)
                     buttonStyle = {
                         ...buttonStyle,
                         tone: defaultMessageType.toLowerCase(),
@@ -473,7 +386,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         return this.getAdaptableAlerts().filter(AdaptableAlert_1.isAdaptableRowChangedAlert);
     }
     getAdaptableAlertWithHighlightCell(columnId, rowNode) {
-        // only alerts triggered by cell changes are relevant for HighlightCell actions
         return this.getAdaptableCellChangedAlerts().find((alert) => (0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert.alertDefinition)?.HighlightCell &&
             alert.cellDataChangedInfo?.column?.columnId === columnId &&
             alert.cellDataChangedInfo?.rowNode === rowNode);
@@ -641,8 +553,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         return true;
     }
     getDefaultAlertNotificationForm() {
-        // we still need the default Notification Form  for historical reasons
-        // (i.e. to be able to display the AlertForm with the default buttons when the user has not defined any buttons)
         return {
             fields: [],
             Buttons: [this.getDefaultButton()],
@@ -656,15 +566,6 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             },
         };
     }
-    /**
-     * Supported tokens:
-     * - column-that-changed-name -> [column]
-     * - rowData.newValue -> [rowData.newValue]
-     * - rowData.oldValue -> [rowData.oldValue]
-     * - primaryKey -> [primaryKeyValue]
-     * - timestamp -> [timestamp]
-     * - trigger -> [trigger]
-     */
     annotateAlertText(text, context) {
         if (!text) {
             return text;
@@ -700,9 +601,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
                 Delete: 'Deleted',
                 Load: 'Loaded',
             };
-            const mappedTrigger = 
-            // @ts-ignore
-            (dataChangeTriggerMap[context.trigger] || rowChangeTriggerMap[context.trigger]) ??
+            const mappedTrigger = (dataChangeTriggerMap[context.trigger] || rowChangeTriggerMap[context.trigger]) ??
                 context.trigger;
             text = Helper_1.default.replaceAll(text, '[trigger]', mappedTrigger);
         }

package/src/Api/Internal/CalculatedColumnInternalApi.js

@@ -8,10 +8,6 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const AdaptableColumn_1 = require("../../AdaptableState/Common/AdaptableColumn");
 class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Returns all the references in the AdaptableState of the given CalculatedColumn
-     * @param calculatedColumn CalculatedColumn to be checked
-     */
     getCalculatedColumnModuleReferences(calculatedColumn) {
         const references = [];
         this.getAdaptableInternalApi()
@@ -25,10 +21,6 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
         });
         return references;
     }
-    /**
-     * Returns all Calculated Columns whose Expression contains the ColumnId
-     * @param columnId ColumnId to check
-     */
     getCalculatedColumnsReferencingColumnId(columnId) {
         const calcColumns = [];
         this.getCalculatedColumnApi()
@@ -40,18 +32,10 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
         });
         return calcColumns;
     }
-    /**
-     * Gets any ColumnIds referenced in a Calculated Column
-     * @param calculatedColumn Calculated Column to check
-     */
     getReferencedColumnIdsForCalculatedColumn(calculatedColumn) {
         const columnIds = this.getExpressionApi().getColumnsFromExpression(this.getExpressionApi().getAdaptableQueryExpression(calculatedColumn.Query));
         return columnIds;
     }
-    /**
-     * Gets any ColumnIds referenced in a Calculated Column
-     * @param calculatedColumnId CalculatedColumnId to check
-     */
     getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId) {
         const calculatedColumn = this.getCalculatedColumnApi()
             .getCalculatedColumns()
@@ -106,7 +90,6 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
                 if (isExternalEvaluation) {
                     return params.data?.[calculatedColumn.ColumnId];
                 }
-                // if the grid data is NOT client side, we can aggregate only simple scalar expression (which depend on row data, not on other rows)
                 if (this.getGridApi().getAgGridRowModelType() !== 'clientSide' &&
                     StringExtensions_1.default.IsNotNullOrEmpty(calculatedColumn.Query.AggregatedScalarExpression)) {
                     return params.data?.[calculatedColumn.ColumnId];

package/src/Api/Internal/ChartingInternalApi.js

@@ -28,7 +28,6 @@ class ChartingInternalApi extends ApiBase_1.ApiBase {
         }
         return candidate;
     }
-    // External lib charting service
     isExternalChartOpened(chartDefinition) {
         const externalChartingOptions = this.getChartingOptions().externalChartingOptions;
         if (!externalChartingOptions?.isChartOpened) {

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -10,20 +10,11 @@ const windowFactory_1 = require("../../View/Components/Popups/WindowPopups/windo
 const ApiBase_1 = require("../Implementation/ApiBase");
 const AdaptableFilterHandler_1 = require("../../agGrid/AdaptableFilterHandler");
 class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Returns Predicate Definition for given Column and Quick Filter shortcut
-     * @param shortcut Quick Filter shortcut to lookup
-     * @param column AdapTable Column being Filtered
-     */
     findPredicateDefByShortcut(shortcut, column) {
         return this.getColumnFilterApi()
             .getFilterPredicateDefsForColumn(column)
             .find((predicateDef) => this.getPredicateDefShortcuts(predicateDef)?.includes(shortcut));
     }
-    /**
-     * Creates an Equality Filter based on given Grid Cells
-     * @param gridCells cells to create Filter for
-     */
     createValuesColumnFilterForCells(gridCells) {
         if (!gridCells) {
             return null;
@@ -40,10 +31,6 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
         const [savedFilter] = this.getColumnFilterApi().setColumnFilters([filter]) || [null];
         return savedFilter;
     }
-    /**
-     *  Creates an Equality Filter based on given Grid Cell
-     * @param gridCell cell to create Filter for
-     */
     createEqualityColumnFilterForCell(gridCell) {
         if (!gridCell) {
             return null;
@@ -61,11 +48,6 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
         const [savedFilter] = this.getColumnFilterApi().setColumnFilters([filter]) || [null];
         return savedFilter;
     }
-    /**
-     * Calls AdapTableQL to evaluate Filter for given Row
-     * @param columnFilter Column Filter to use
-     * @param node Row Node to evaluate
-     */
     evaluateColumnFilter(columnFilter, node) {
         if (!columnFilter.Predicates.length) {
             return true;
@@ -101,24 +83,9 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             predicatesOperator: columnFilter.PredicatesOperator,
             ...this.getAdaptableInternalApi().buildBaseContext(),
         };
-        //  #column_filter_predicates_evaluation
         return this.getPredicateApi().handlePredicates(columnFilter.Predicates, predicateDefHandlerContext, true);
     }
-    /**
-     * Checks if the filter action should trigger Column Filtering
-     *
-     * @param action Filtering Action
-     */
     shouldNewColumnFilterTriggerColumnFiltering(action) {
-        // trigger filter change only:
-        // - new -> new filter is active
-        // - clear -> previous filters was active
-        // - clearAll -> a filter was active
-        // - edit -> same => input change
-        // - edit -> different & new is active
-        // - edit -> different & old was active
-        // - set -> new filter is active
-        // filter -> suspend changes
         const isNewAndActive = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_ADD &&
             this.getColumnFilterApi().isColumnFilterActive(action.columnFilter);
         const isClearAndPreviousWasActive = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR &&
@@ -131,19 +98,15 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
         if (action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_EDIT) {
             const newFilter = action.columnFilter;
             const previous = this.getColumnFilterApi().getColumnFilterForColumn(newFilter.ColumnId);
-            // same filter edit, so always trigger
             if (previous &&
                 newFilter &&
-                // same predicates
                 (0, ArrayExtensions_1.areArraysEqual)(previous.Predicates.map((p) => p.PredicateId), newFilter.Predicates.map((p) => p.PredicateId))) {
                 isEditTrigger = true;
-                // new filter is active
             }
             else if (this.getColumnFilterApi().isColumnFilterActive(newFilter)) {
                 isEditTrigger = true;
             }
             else if (this.getColumnFilterApi().isColumnFilterActive(previous)) {
-                // previous filter was active
                 isEditTrigger = true;
             }
         }
@@ -162,17 +125,11 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             isSetAndActive ||
             isSuspendChanged);
     }
-    /**
-     * Compares to sets of Column Filters to see if they are identical
-     * @param filters1
-     * @param filters2
-     */
     areColumnFiltersDifferent(oldFilters, newFilters) {
         if (ArrayExtensions_1.default.IsNullOrEmpty(oldFilters) && ArrayExtensions_1.default.IsNullOrEmpty(newFilters)) {
             return false;
         }
         return !ArrayExtensions_1.default.areArraysEqualWithCustomComparator(oldFilters, newFilters, (filter1, filter2) => {
-            // Compare basic properties
             if (filter1.ColumnId !== filter2.ColumnId) {
                 return false;
             }
@@ -182,12 +139,10 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             if ((filter1.IsSuspended || false) !== (filter2.IsSuspended || false)) {
                 return false;
             }
-            // Compare predicates (regardless of order)
             return ArrayExtensions_1.default.areArraysEqualWithCustomComparator(filter1.Predicates, filter2.Predicates, (pred1, pred2) => {
                 if (pred1.PredicateId !== pred2.PredicateId) {
                     return false;
                 }
-                // Compare inputs array (might be primitives or objects)
                 return ArrayExtensions_1.default.areArraysEqualWithCustomComparator(pred1.Inputs, pred2.Inputs, (input1, input2) => {
                     if (input1 === input2) {
                         return true;
@@ -195,7 +150,6 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
                     if (typeof input1 !== typeof input2) {
                         return false;
                     }
-                    // For object inputs, use JSON comparison
                     if (typeof input1 === 'object' && input1 !== null && input2 !== null) {
                         return JSON.stringify(input1) === JSON.stringify(input2);
                     }
@@ -241,16 +195,11 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             },
         });
     }
-    /**
-     * First we try to get the cached values from the FilterHandler
-     * Only if the FilterHandler is not available we fallback to the GridApi method
-     */
     async getColumnFilterValues(options) {
         const filterOptions = this.getOptionsApi().getFilterOptions();
         const newOptions = {
             columnId: options.columnId,
             get currentSearchValue() {
-                // we need this in order to keep it lazy
                 return options.currentSearchValue;
             },
             previousResult: undefined,
@@ -282,7 +231,6 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             };
             return manuallyApplyColumnFilterOpt(context);
         }
-        // fallback, should never happen
         return false;
     }
     getAdaptableFilterHandler(columnId) {

package/src/Api/Internal/ColumnInternalApi.js

@@ -16,13 +16,6 @@ function getAutoRowGroupColumnIdFor(columnId) {
     return `${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-${columnId}`;
 }
 class ColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Retrieves 'ColumnType' property for a given Column
-     *   isCumulativeAggregate(input: string): boolean {
-     *     return !!this.getNodesFromExpression(input, 'CUMUL')?.length;
-     *   }
-     * @param columnId Column to use
-     */
     getAgGridColumnType(columnId) {
         return this._adaptable.getAgGridColumnType(columnId);
     }
@@ -41,9 +34,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         });
         return (0, ArrayExtensions_1.uniq)(colTypes).filter((c) => StringExtensions_1.default.IsNotNullOrEmptyOrWhiteSpace(c));
     }
-    /**
-     * Retrieves a list providing the Friendly Name / Caption for all columns
-     */
     getAllColumnFriendlyNames() {
         return this.getColumnApi()
             .getColumns()
@@ -54,18 +44,10 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
     getAutoRowGroupColumnIdFor(columnId) {
         return getAutoRowGroupColumnIdFor(columnId);
     }
-    /**
-     * Retrieves AG Grid's field property for the column
-     * @param columnId columnId to look up
-     */
     getAgGridColumnFieldForAdaptableColumn(columnId) {
         const agGridColumn = this.getAgGridColumnForAdaptableColumn(columnId);
         return agGridColumn.getColDef().field || '';
     }
-    /**
-     * Retrieves AG Grid's column for an Adaptable column
-     * @param columnId columnId to look up
-     */
     getAgGridColumnForAdaptableColumn(columnId) {
         return this._adaptable.getAgGridColumnForColumnId(columnId);
     }
@@ -80,7 +62,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
                 this.getColumnApi().isFdc3Column(columnId));
     }
     getColumnHeaderName(params) {
-        // this is the same object, but casting it makes it easier to work with
         const isColumn = !params.columnGroup;
         const columnParams = params;
         const isColumnGroup = !!params.columnGroup;
@@ -88,16 +69,13 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         const defaultHeaderName = params.colDef?.headerName ??
             (isColumn ? StringExtensions_1.default.CamelCaseToHumanText(columnParams.colDef?.field) : '') ??
             '';
-        // for now we override ONLY the header names
         if (params.location !== 'header') {
             return defaultHeaderName;
         }
-        // 1. Layout specific header has the highest priority
         const layoutSpecificCustomHeader = this.getLayoutApi().getCurrentLayout().ColumnHeaders?.[isColumn ? columnParams.column.getColId() : columnGroupParams.columnGroup.getGroupId()];
         if (layoutSpecificCustomHeader) {
             return layoutSpecificCustomHeader;
         }
-        // 2. check for custom ColumnOptions.columnHeader
         if (typeof this.getColumnOptions().columnHeader === 'function') {
             const columnHeaderContext = this.buildColumnHeaderContext(params, defaultHeaderName);
             if (columnHeaderContext === 'skip') {
@@ -106,7 +84,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
             const customHeader = this.getColumnOptions().columnHeader(columnHeaderContext);
             return customHeader;
         }
-        // 3. fallback to default header name
         return defaultHeaderName;
     }
     buildColumnHeaderContext(params, defaultHeaderName) {
@@ -119,7 +96,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
             currentLayoutName: currentLayout.Name,
             currentLayoutType: currentLayoutType,
         };
-        // makes it easier to work with
         const currentTableLayout = currentLayout;
         const currentPivotLayout = currentLayout;
         if (params.column?.getColId() === GeneralConstants_1.AG_GRID_GROUPED_COLUMN) {
@@ -136,7 +112,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         if (params.column?.getColId().startsWith(`${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-`)) {
             const columnType = 'rowGroupColumn';
             const columnId = params.column.getColId();
-            // remove `${AG_GRID_GROUPED_COLUMN}-` from beginning of columnId
             const groupColumnId = columnId.substring(`${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-`.length);
             return {
                 ...baseContext,
@@ -149,8 +124,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
             if (params.columnGroup) {
                 const columnType = 'tableColumnGroup';
                 if (!params.colDef?.children) {
-                    // AG Grid created virtual column groups for all columns
-                    // we want to skip those
                     return 'skip';
                 }
                 return {
@@ -183,7 +156,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         if (baseContext.currentLayoutType === 'pivot') {
             if (params.columnGroup) {
                 if (!params.colDef?.pivotKeys) {
-                    // we might have user defined colGroups, but we are not interested in them in pivot mode
                     return 'skip';
                 }
                 const columnType = 'pivotColumnGroup';
@@ -205,7 +177,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
                     const aggregatedColumnId = pivotValueCol?.getColId();
                     const currentLayoutAggCols = currentPivotLayout.PivotAggregationColumns?.map((col) => col.ColumnId);
                     if (!currentLayoutAggCols?.includes(aggregatedColumnId)) {
-                        // this column is not an aggregation column
                         return 'skip';
                     }
                     return {
@@ -259,7 +230,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
                     const aggregatedColumnId = pivotValueCol?.getColId();
                     const currentLayoutAggCols = currentPivotLayout.PivotAggregationColumns?.map((col) => col.ColumnId);
                     if (!currentLayoutAggCols?.includes(aggregatedColumnId)) {
-                        // this column is not an aggregation column
                         return 'skip';
                     }
                     return {
@@ -273,7 +243,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
                 }
             }
         }
-        // if nothing matched, we skip this column[group]
         return 'skip';
     }
     hasArrayDataType(column) {
@@ -290,7 +259,6 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         return this.getColumnApi().hasColumnType(columnIdentifier, AdaptableColumn_1.HIDDEN_COLUMN_TYPE);
     }
     getColumnDateTypes() {
-        // this is required because Adaptable uses 'date' type for all AG Grid date types: 'date', 'dateString'
         return ['date'];
     }
 }

package/src/Api/Internal/CustomSortInternalApi.js

@@ -21,7 +21,6 @@ class CustomSortInternalApi extends ApiBase_1.ApiBase {
         return `${value}`;
     }
     getDefaultCustomSortComparer(columnId, columnValues) {
-        // have to return a function that may not have access to this
         const gridApi = this.getGridApi();
         const columnDataType = this.getColumnApi().getColumnDataTypeForColumnId(columnId);
         const _this = this;
@@ -34,22 +33,18 @@ class CustomSortInternalApi extends ApiBase_1.ApiBase {
             let containsFirstElement = indexFirstElement >= 0;
             let indexSecondElement = columnValues.indexOf(secondCustomSortValue);
             let containsSecondElement = indexSecondElement >= 0;
-            //if none of the element are in the list we jsut return normal compare
             if (!containsFirstElement && !containsSecondElement) {
                 if (valueA == valueB) {
                     return 0;
                 }
                 return valueA < valueB ? -1 : 1;
             }
-            //if first item not in the list make sure we put it after the second item
             if (!containsFirstElement) {
                 return 1;
             }
-            //if second item not in the list make sure we put it after the first item
             if (!containsSecondElement) {
                 return -1;
             }
-            //return the comparison from the list if the two items are in the list
             return indexFirstElement - indexSecondElement;
         };
     }

package/src/Api/Internal/DashboardInternalApi.js

@@ -4,38 +4,15 @@ exports.DashboardInternalApi = void 0;
 const Types_1 = require("../../AdaptableState/Common/Types");
 const ApiBase_1 = require("../Implementation/ApiBase");
 class DashboardInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Registry of reset-callbacks keyed by Custom-Toolbar name. Each
-     * `CustomToolbarCmp` registers itself on mount so the public
-     * {@link DashboardApi.resetCustomToolbarFormData} method can ask
-     * a specific instance to roll its `toolbarForm` data back to its
-     * declared `defaultValue`s without re-mounting the component.
-     */
     customToolbarFormResetters = new Map();
-    /**
-     * Register a reset callback for a Custom Toolbar. Idempotent: a second
-     * registration for the same name overwrites the previous entry, so a
-     * remount of the same toolbar always wins.
-     */
     registerCustomToolbarFormResetter(toolbarName, resetter) {
         this.customToolbarFormResetters.set(toolbarName, resetter);
     }
-    /**
-     * Tear down a previously-registered reset callback, but only if it's
-     * still the active one. Guards against a stale unmount clobbering a
-     * registration made by a fresh mount of the same toolbar.
-     */
     unregisterCustomToolbarFormResetter(toolbarName, resetter) {
         if (this.customToolbarFormResetters.get(toolbarName) === resetter) {
             this.customToolbarFormResetters.delete(toolbarName);
         }
     }
-    /**
-     * Invokes the registered reset callback for the given toolbar (or all
-     * registered toolbars when `toolbarName` is omitted). Silently no-ops
-     * if no toolbar is registered under the given name - this is benign
-     * (e.g. the toolbar has not yet mounted, or it has no `toolbarForm`).
-     */
     resetCustomToolbarFormData(toolbarName) {
         if (toolbarName) {
             const fn = this.customToolbarFormResetters.get(toolbarName);

package/src/Api/Internal/DataImportInternalApi.js

@@ -60,7 +60,6 @@ class DataImportInternalApi extends ApiBase_1.ApiBase {
         };
         this.getAlertApi().displayAdaptableAlert(alert);
         const dataImportedInfo = this.getEventApi().internalApi.fireDataImportedEvent(importData, addedRows, updatedRows);
-        // Dispatch action (purely so it will be in Audit Log)
         this.getAdaptableInternalApi().dispatchReduxAction(InternalRedux.DataImportCompleted(dataImportedInfo));
     }
 }