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

package/src/AdaptableState/Common/AdaptablePredicate.js

@@ -19,13 +19,12 @@ function getGroupValuesForNode(config) {
     const { node, value } = config;
     const groupValues = node.group
         ? []
-        : /*for the leaf node, also use its value*/ value != null
+        : value != null
             ? [value]
             : [];
     let currentNode = node.group ? node : node.parent;
     while (currentNode && currentNode.groupData && Object.keys(currentNode.groupData).length > 0) {
         if (currentNode.treeParent && !currentNode.data) {
-            // skip filler groups in tree mode
         }
         else {
             groupValues.unshift(currentNode.groupData[AG_GRID_GROUPED_COLUMN]);
@@ -34,9 +33,6 @@ function getGroupValuesForNode(config) {
     }
     return groupValues;
 }
-/**
- * Array of Predicate Defs which are shipped by AdapTable
- */
 export const SystemPredicateDefs = [
     {
         id: 'In',
@@ -55,11 +51,8 @@ export const SystemPredicateDefs = [
                 if (!predicateInput) {
                     return;
                 }
-                // make sure that the input Predicate  is included in the 'In' Predicate
                 if (adaptableApi.columnScopeApi.scopeIsAll(predicateInput.columnScope) ||
-                    adaptableApi.columnScopeApi.isScopeInScope(predicateInput.columnScope, 
-                    // 'In' ColumnScope
-                    {
+                    adaptableApi.columnScopeApi.isScopeInScope(predicateInput.columnScope, {
                         DataTypes: ['text', 'number', 'date', 'textArray', 'numberArray'],
                     })) {
                     return predicateInput;
@@ -75,7 +68,6 @@ export const SystemPredicateDefs = [
                     }, nestedContext, false);
                 });
                 if (predicateResult) {
-                    // We want to use the only true values, to allow for multiple predicates to be used
                     return predicateResult;
                 }
             }
@@ -85,17 +77,7 @@ export const SystemPredicateDefs = [
             if (column.columnId === AG_GRID_GROUPED_COLUMN) {
                 const { node, treeSelectionState } = context;
                 const groupValues = getGroupValuesForNode({ node, value });
-                // for non-trees, this line is reached for every leaf-row
-                // so for 2 levels-deep, groupValues is an array of ['level1-value','level2-value','leaf-value']
-                // but for trees, the groupValues is first an array with only
-                // one value, the current branch root - and if we go via the treeSelectionState
-                // that root might have a leaf selected, but if we return true here
-                // ag grid would include all rows of that branch - which is not what we want
-                // so we want to enter the `if` block and use the startsWith check
                 if (column.isTreeColumn || !treeSelectionState) {
-                    // in case we don't have treeSelectionState
-                    // this is another possible implementation
-                    // though it won't be as performant as using the treeSelectionState
                     const currentValues = (groupValues ?? []).join('#');
                     return inputs.some((values) => {
                         const valuesString = values.join('#');
@@ -103,32 +85,14 @@ export const SystemPredicateDefs = [
                     });
                 }
                 const result = groupValues ? treeSelectionState.isNodeSelected(groupValues) : false;
-                // console.log('filter', groupValues, 'pass', result, treeSelectionState.getState());
                 return result;
             }
             if (column.dataType === 'date') {
-                // Inputs come from one of two flows:
-                //   1. The default-values tree's calendar leaves — short strings
-                //      like "2024", "2024-01" or "2024-01-15" (no time component).
-                //   2. A full timestamp — either the tree's optional time leaf or
-                //      the `customInFilterValues` + `orderedValues` path, where
-                //      `Date` values are normalised to ISO strings (always carrying
-                //      a `T` separator).
-                //
-                // `evaluateInPredicateUsingTime` is only meaningful for case (1):
-                // it switches the calendar leaf between day-level matching and
-                // exact-instant matching against the cell's `Date`. For case (2)
-                // the user has explicitly picked a specific instant, so we always
-                // compare with time regardless of the option.
                 return inputs.some((input) => {
                     const hasTimeComponent = typeof input === 'string' && input.includes('T');
                     const useTime = hasTimeComponent ||
                         adaptableApi.predicateApi.internalApi.shouldEvaluateInPredicateUsingTime(column.columnId);
                     if (useTime) {
-                        // `input` may be a string (e.g. an ISO timestamp serialised through
-                        // JSON when the listbox tree dropdown round-trips path keys), so
-                        // normalise both sides to `Date` before comparing — date-fns
-                        // `isEqual` only accepts `Date | number`.
                         return isEqual(parseDateValue(input), parseDateValue(value));
                     }
                     else {
@@ -168,80 +132,6 @@ export const SystemPredicateDefs = [
         toString: ({ inputs }) => `IN (${inputs.join(', ')})`,
         shortcuts: ['#', '['],
     },
-    // {
-    //   id: 'Tree',
-    //   label: 'Tree',
-    //   icon: { text: 'Tree' },
-    //   columnScope: { DataTypes: ['date'] },
-    //   moduleScope: ['columnFilter', 'flashingcell', 'formatColumn', 'alert'],
-    //   handler: (context) => {
-    //     const { inputs = [], column, value, adaptableApi } = context;
-    //     const predicateInputs = (context.inputs || []).reduce<AdaptablePredicateDef[]>(
-    //       (acc, input) => {
-    //         const predicate = adaptableApi.predicateApi.getPredicateDefById(input);
-    //         if (predicate) {
-    //           acc.push(predicate);
-    //         }
-    //         return acc;
-    //       },
-    //       []
-    //     );
-    //     if (predicateInputs.length) {
-    //       const nestedContext = { ...context };
-    //       delete nestedContext.inputs;
-    //       const predicateResult = predicateInputs.some((predicate) => {
-    //         return adaptableApi.predicateApi.handlePredicate(
-    //           {
-    //             PredicateId: predicate.id,
-    //           },
-    //           nestedContext,
-    //           false
-    //         );
-    //       });
-    //       if (predicateResult) {
-    //         // We want to use the only true values, to allow for multiple predicates to be used
-    //         return predicateResult;
-    //       }
-    //     }
-    //     if (inputs.length === 0) {
-    //       return true;
-    //     }
-    //     if (column.dataType === 'date') {
-    //       const treeSelectionState = new TreeSelectionState(
-    //         {
-    //           defaultSelection: false,
-    //           // make sure something like
-    //           // Predicates: [{ PredicateId: 'Tree', Inputs: [['2021', '2'], ['2022']] }],
-    //           // is always converted to numbers
-    //           selectedPaths: inputs
-    //             .map((array) => {
-    //               if (!Array.isArray(array)) {
-    //                 return null;
-    //               }
-    //               return array.map(Number);
-    //             })
-    //             .filter(Boolean),
-    //         },
-    //         () => {
-    //           return {
-    //             treeDeepMap: new DeepMap<string, any>(),
-    //             treePaths: new DeepMap<string, any>(),
-    //           };
-    //         }
-    //       );
-    //       const currrentDate = parseDateValue(value);
-    //       const currentYear = currrentDate.getFullYear();
-    //       const currentMonth = currrentDate.getMonth() + 1;
-    //       const currentDay = currrentDate.getDate();
-    //       const result = treeSelectionState.isNodeSelected([currentYear, currentMonth, currentDay]);
-    //       // console.log({ currentYear, currentMonth, currentDay, result, inputs: inputs.join('-') });
-    //       return result;
-    //     }
-    //     return true;
-    //   },
-    //   toString: ({ inputs }) => `IN Tree (${inputs.join(', ')})`,
-    //   shortcuts: ['#', '['],
-    // },
     {
         id: 'NotIn',
         label: 'Not In',
@@ -256,11 +146,8 @@ export const SystemPredicateDefs = [
                 if (!predicateInput) {
                     return;
                 }
-                // make sure that the input Predicate  is included in the 'NotIn' Predicate
                 if (adaptableApi.columnScopeApi.scopeIsAll(predicateInput.columnScope) ||
-                    adaptableApi.columnScopeApi.isScopeInScope(predicateInput.columnScope, 
-                    // 'NotIn' ColumnScope
-                    {
+                    adaptableApi.columnScopeApi.isScopeInScope(predicateInput.columnScope, {
                         DataTypes: ['text', 'number', 'date', 'textArray', 'numberArray'],
                     })) {
                     return predicateInput;
@@ -277,11 +164,9 @@ export const SystemPredicateDefs = [
                     return res === false;
                 });
                 if (!predicateResult) {
-                    // We want to use the only true values, to allow for multiple predicates to be used
                     return false;
                 }
             }
-            // basically negation of IN
             if (inputs.length === 0) {
                 return true;
             }
@@ -357,7 +242,6 @@ export const SystemPredicateDefs = [
             return Helper.isInputNotNullOrEmpty(value);
         },
     },
-    // Numeric System Filters
     {
         id: 'GreaterThan',
         label: 'Greater Than',
@@ -470,7 +354,6 @@ export const SystemPredicateDefs = [
         toString: ({ inputs }) => `Not Between ${inputs[0] ?? ''}:${inputs[1]}`,
         shortcuts: ['!:'],
     },
-    // String System Filters
     {
         id: 'Is',
         label: 'Equals',
@@ -591,7 +474,6 @@ export const SystemPredicateDefs = [
         handler: ({ value, inputs }) => new RegExp(inputs[0]).test(value),
         toString: ({ inputs }) => `Regex ${inputs[0] ?? ''}`,
     },
-    // Date System Filters
     {
         id: 'Today',
         label: 'Today',
@@ -745,7 +627,6 @@ export const SystemPredicateDefs = [
         inputs: [{ type: 'date' }, { type: 'date' }],
         handler: ({ value, inputs }) => new Date(value) >= new Date(inputs[0]) && new Date(value) <= new Date(inputs[1]),
     },
-    // Boolean System Filters
     {
         id: 'True',
         label: 'True',
@@ -769,17 +650,14 @@ export const SystemPredicateDefs = [
         columnScope: { DataTypes: ['boolean'] },
         moduleScope: ['columnFilter'],
         inputs: [{ type: 'boolean' }],
-        // working with string aliases instead of booleans because the ColumnFilterAPI cannot handle falsy filter values (it ignores them)
         handler: ({ value, inputs }) => {
             if (inputs[0] == 'all') {
-                // if it's indeterminate, all values (true&false) are matched
                 return true;
             }
             const booleanInputValue = inputs[0] === 'checked' ? true : false;
             return Boolean(value) === Boolean(booleanInputValue);
         },
     },
-    // Other System Filters
     {
         id: 'AnyChange',
         label: 'Any Change',

package/src/AdaptableState/Common/AggregationColumns.js

@@ -17,21 +17,11 @@ export const getAggFuncName = (aggFunc) => {
         return aggFunc;
     }
 };
-/**
- * Whether the Weighted Average aggregation should be offered for this Column:
- * it must be a numeric, aggregatable Column that either has no agg-func
- * restriction or explicitly allows `weightedAvg`.
- */
 export const isWeightedAverageAggFuncEligible = (column) => {
     const weightedAverageAllowed = !column.userAllowedAggFuncs?.length ||
         column.userAllowedAggFuncs.includes(WEIGHTED_AVERAGE_AGG_FN_NAME);
     return column.dataType === 'number' && column.aggregatable && weightedAverageAllowed;
 };
-/**
- * Returns the Column's available aggregation function names ordered for display,
- * ensuring `weightedAvg` is positioned right after `avg` (and only present when
- * the Column is eligible for Weighted Average).
- */
 export const getDisplayAggFuncNames = (column) => {
     const names = [...new Set(column.availableAggregationFunctions || [])].filter((name) => name !== WEIGHTED_AVERAGE_AGG_FN_NAME);
     if (isWeightedAverageAggFuncEligible(column)) {

package/src/AdaptableState/Common/Enums.js

@@ -1,4 +1,3 @@
-// General Enums
 export var MathOperation;
 (function (MathOperation) {
     MathOperation["Add"] = "Add";
@@ -6,7 +5,6 @@ export var MathOperation;
     MathOperation["Multiply"] = "Multiply";
     MathOperation["Divide"] = "Divide";
 })(MathOperation || (MathOperation = {}));
-// Enums used in Strategies
 export var SortOrder;
 (function (SortOrder) {
     SortOrder["Asc"] = "Asc";
@@ -24,7 +22,6 @@ export var FontStyle;
 })(FontStyle || (FontStyle = {}));
 export var FontSize;
 (function (FontSize) {
-    //  Default = 'Default',
     FontSize["XSmall"] = "XSmall";
     FontSize["Small"] = "Small";
     FontSize["Medium"] = "Medium";

package/src/AdaptableState/Common/Menu.js

@@ -1,6 +1,3 @@
-/**
- * List of Shipped Adaptable Column Menu Items
- */
 export const ADAPTABLE_COLUMN_MENU_ITEMS = [
     'calculated-column-edit',
     'cell-summary-show',
@@ -61,12 +58,9 @@ export const ADAPTABLE_COLUMN_MENU_ITEMS = [
     'styled-column-icon-add',
     'styled-column-icon-edit',
     'system-status-show',
-    '_navbar', // used in SettingsPanel navigation bar and in Dashboard Module buttons
+    '_navbar',
     'separator',
 ];
-/**
- * List of Shipped Adaptable Context Menu Items
- */
 export const ADAPTABLE_CONTEXT_MENU_ITEMS = [
     'menu-group',
     'alert-clear',

package/src/AdaptableState/Common/MenuItem.js

@@ -1,5 +1,4 @@
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
-// A menu item which performs a Redux Action when it is clicke
 export class MenuItemDoReduxAction {
     constructor(name, label, module, reduxAction, icon, isVisible) {
         this.name = name;
@@ -36,7 +35,6 @@ export class MenuItemDoClickFunction {
     isVisible;
     icon;
 }
-// A menu item which shows a popup screen when it is clieked
 export class MenuItemShowPopup {
     constructor(name, label, module, componentName, icon, isVisible, popupParams) {
         this.name = name;

package/src/AdaptableState/Common/Types.js

@@ -1,6 +1,3 @@
-/*
-This page includes frequently used typed - particularly helpful for State and Api where we can strongly type stuff
-*/
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 export const ALL_TOOLBARS = [
     'Alert',
@@ -12,8 +9,8 @@ export const ALL_TOOLBARS = [
     'Export',
     'IPushPull',
     'Layout',
-    'ColumnFilter', // controlled by layout module
-    'GridFilter', // controlled by layout module
+    'ColumnFilter',
+    'GridFilter',
     'OpenFin',
     'QuickSearch',
     'SmartEdit',

package/src/AdaptableState/StatusBarState.js

@@ -1,4 +1 @@
-/**
- * Name of the component specified in AG Grid gridOptions.statusBar.statusPanels
- */
 export const ADAPTABLE_STATUS_PANEL = 'AdaptableStatusPanel';

package/src/AdaptableState/StyledColumns/BadgeStyle.js

@@ -1,4 +1,3 @@
-/** Keys copied from legacy `BadgeStyleDefinition.Style` (`AdaptableStyle`) into `PillStyle`. */
 export const BADGE_PILL_STYLE_KEYS = [
     'BackColor',
     'ForeColor',

package/src/AdaptableState/StyledColumns/Common/BarStyleProperties.js

@@ -1,5 +1 @@
-/**
- * Marker primitives shared by bar-chart-style Styled Columns —
- * Bullet Chart target markers and Range Bar value / reference markers.
- */
 export {};

package/src/AdaptableState/StyledColumns/Common/CellTextOptions.js

@@ -1,6 +1 @@
-/**
- * Cell-text token primitives shared by several Styled Column types
- * (Percent Bar, Gradient, Bullet Chart, Range Bar, Rating) when configuring
- * what to display as text overlay / tooltip content.
- */
 export {};

package/src/AdaptableState/StyledColumns/Common/NumericStyledColumn.js

@@ -1,9 +1 @@
-/**
- * Numeric scale primitives shared by every numeric Styled Column type
- * (Gradient, Percent Bar, Bullet Chart, Range Bar).
- *
- * These types describe how a column's numeric scale is resolved (via
- * literal numbers, dynamic column-wide aggregates, or comparison against
- * another column) and how that scale is segmented into coloured ranges.
- */
 export {};

package/src/AdaptableState/Uuid.js

@@ -1,3 +1,2 @@
 import { v4 as uuidv4 } from 'uuid';
-// TODO: replace this redundancy with 'the createUuid()' from 'utils/uuid.ts'
 export const createUuid = () => uuidv4();

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -151,15 +151,11 @@ export class AdaptableApiImpl {
         this.dataImportApi = new DataImportApiImpl(adaptable);
         this.filterApi = new FilterApiImpl(adaptable);
         this.commentApi = new CommentsApiImpl(adaptable);
-        // adaptable internal api
         this.internalApi = new AdaptableInternalApi(adaptable);
     }
     get agGridApi() {
         return this.adaptable?.agGridAdapter?.getAgGridApi();
     }
-    /**
-     * This is only meant to be called by the Adaptable instance.
-     */
     _internalDestroySelf() {
         if (this.destroyed) {
             return;

package/src/Api/Implementation/AlertApiImpl.js

@@ -43,29 +43,21 @@ export class AlertApiImpl extends 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 = resolveContainerElement(this.getContainerOptions().alertContainer, this.getAdaptableInternalApi().buildBaseContext());
                 if (alertDiv) {
@@ -77,13 +69,11 @@ export class AlertApiImpl extends ApiBase {
                 return;
             }
             const alertProperties = alertDefinition.AlertProperties ?? {};
-            // Jump to the Cell
             if (alertProperties.JumpToCell &&
                 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 &&
                 isAdaptableRowChangedAlert(alertToShow) &&
                 alertToShow.rowDataChangedInfo?.rowTrigger === 'Add') {
@@ -92,8 +82,6 @@ export class AlertApiImpl extends 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 (isAdaptableCellChangedAlert(alertToShow) &&
                 alertToShow.cellDataChangedInfo &&
                 (alertProperties.HighlightCell || alertProperties.HighlightRow)) {
@@ -116,7 +104,6 @@ export class AlertApiImpl extends 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 &&
                 isAdaptableRowChangedAlert(alertToShow) &&
                 alertToShow.rowDataChangedInfo?.rowTrigger === 'Add') {
@@ -181,8 +168,6 @@ export class AlertApiImpl extends 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;
@@ -200,7 +185,6 @@ export class AlertApiImpl extends 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);
         });
@@ -215,19 +199,15 @@ export class AlertApiImpl extends ApiBase {
         if (!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.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);
@@ -235,7 +215,6 @@ export class AlertApiImpl extends 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

@@ -1,12 +1,7 @@
 import Helper from '../../Utilities/Helpers/Helper';
 import { createUuid } from '../../AdaptableState/Uuid';
-// Base class for the Api - provides checking dispatching methods
 export 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;
     }
@@ -31,14 +26,6 @@ export 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.objectNotExists(item)) {
             this.logError(`No ${type} found with the name: ${name}`);
@@ -62,29 +49,18 @@ export 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 = createUuid();

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -48,7 +48,6 @@ export class CalculatedColumnApiImpl extends 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

@@ -6,9 +6,6 @@ import { ChartingInternalApi } from '../Internal/ChartingInternalApi';
 import ObjectFactory from '../../Utilities/ObjectFactory';
 import { validateChartName } from '../../Utilities/Helpers/ChartHelper';
 export class ChartingApiImpl extends ApiBase {
-    /**
-     * @internal
-     */
     internalApi;
     constructor(_adaptable) {
         super(_adaptable);

package/src/Api/Implementation/ColumnApiImpl.js

@@ -97,15 +97,6 @@ export 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)
@@ -113,7 +104,6 @@ export function getFriendlyNameForPivotResultColumn(columnId, agGridApi) {
         .join(' ')}`;
 }
 export 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);
 }
 export function isPivotGrandTotal(columnId) {
@@ -131,7 +121,6 @@ export class ColumnApiImpl extends 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() {
@@ -194,7 +183,6 @@ export class ColumnApiImpl extends ApiBase {
         if (!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);
         }
@@ -240,7 +228,6 @@ export class ColumnApiImpl extends ApiBase {
         if (columnId == undefined) {
             return;
         }
-        // just return null if no columns rather than logging a warning - otherwise get lots at startup
         if (ArrayExtensions.IsNullOrEmpty(this.getColumns())) {
             return;
         }
@@ -352,7 +339,7 @@ export class ColumnApiImpl extends 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) {
@@ -390,7 +377,6 @@ export class ColumnApiImpl extends 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.IsNullOrEmpty(this.getColumns())) {
             return null;
         }