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

package/src/Api/Implementation/PredicateApiImpl.js

@@ -112,7 +112,6 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         if (!adaptablePredicateDef) {
             return false;
         }
-        // not perfect but if there are no inputs - and there should be some - we treat the filter as invalid
         if (adaptablePredicateDef.inputs) {
             if (ArrayExtensions_1.default.IsNullOrEmpty(predicate.Inputs) ||
                 StringExtensions_1.default.IsNullOrEmpty(predicate.Inputs[0])) {
@@ -132,7 +131,6 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         const paramsForColumn = {
             ...context,
             column: this.getColumnApi().getColumnWithColumnId(predicate.ColumnId),
-            // value: params?.node?.data?.[predicate.ColumnId],
             value: this.getGridApi().getRawValueFromRowNode(context.node, predicate.ColumnId),
         };
         if ('oldValue' in paramsForColumn) {
@@ -147,9 +145,6 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         if (!predicate) {
             return defaultReturn;
         }
-        // memoization to avoid repeated lookups
-        // during filtering of large datasets
-        // see #column_filter_predicates_evaluation
         let predicateDef = predicateDefMap_MEMO.get(predicate.PredicateId);
         if (predicateDef === undefined) {
             predicateDef = this.getPredicateDefById(predicate.PredicateId);

package/src/Api/Implementation/RowFormApiImpl.js

@@ -20,7 +20,6 @@ class RowFormApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction((0, PopupRedux_1.PopupShowForm)({
             Id: 'edit_row_form',
             Form: editForm,
-            // formProps are added to the formContext
             FormProps: {
                 rowNode,
             },
@@ -43,7 +42,6 @@ class RowFormApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction((0, PopupRedux_1.PopupShowForm)({
             Id: 'create_row_form',
             Form: createForm,
-            // formProps are added to the formContext
             FormProps: {
                 clonedRowNode: rowNode,
             },

package/src/Api/Implementation/StateApiImpl.js

@@ -46,9 +46,7 @@ class StateApiImpl extends ApiBase_1.ApiBase {
         Helper_1.default.copyToClipboard(stringifiedState);
     }
     copyUserStateToClipboard() {
-        // This doesnt currently work...
         let state = this.getAdaptableState();
-        //  let userState = state
         let stringifiedState = JSON.stringify(state);
         Helper_1.default.copyToClipboard(stringifiedState);
     }
@@ -115,8 +113,6 @@ class StateApiImpl extends ApiBase_1.ApiBase {
         return new Promise((resolve, reject) => {
             this.getAdaptableInternalApi().executeWithProgressIndicator(config?.progressIndicatorLabel ?? `Initialising...`, () => {
                 const flushCurrentState = !config || config.flushCurrentState !== false;
-                // make sure we persist any "pending" changes to state - since stateOptions.debounceStateDelay can cause
-                // the state to be persisted with a delay, which we dont want in this case
                 const flushStatePromise = flushCurrentState
                     ? this.getAdaptableStore().saveStateNow(this._adaptable)
                     : Promise.resolve(true);
@@ -145,10 +141,8 @@ class StateApiImpl extends ApiBase_1.ApiBase {
                         this._adaptable.refreshLayout();
                     })
                         .then(() => {
-                        // resolve main(result) promise
                         resolve();
                     }, (error) => {
-                        // reject main(result) promise
                         reject(error);
                     })
                         .catch((e) => {
@@ -251,7 +245,6 @@ class StateApiImpl extends ApiBase_1.ApiBase {
         else {
             state.Revision.Key += 1;
         }
-        // need to save it...
     }
     getAlertState(returnJson = false) {
         return this.getUserStateByStateKey('Alert', returnJson);

package/src/Api/Implementation/SystemStatusApiImpl.js

@@ -22,7 +22,6 @@ class SystemStatusApiImpl extends ApiBase_1.ApiBase {
     setSystemStatus(statusMessage, messageType, statusFurtherInformation) {
         let systemStatusMessageInfo = ObjectFactory_1.default.CreateSystemStatusMessageInfo(statusMessage, messageType, statusFurtherInformation ? statusFurtherInformation : '');
         this.internalApi.addSystemStatusMessageInfo(systemStatusMessageInfo);
-        // publish the event
         this.getEventApi().internalApi.fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo);
         if (this.getNotificationsOptions().showSystemStatusMessageNotifications) {
             const alertApi = this.getAlertApi();
@@ -48,7 +47,6 @@ class SystemStatusApiImpl extends ApiBase_1.ApiBase {
         if (this.getContainerOptions().systemStatusContainer != null) {
             this.displayMessageInDiv(statusMessage, statusFurtherInformation, messageType);
         }
-        // doesnt do anything but useful for Audit
         this.dispatchAction(SystemStatusRedux.SystemStatusSetMesage(systemStatusMessageInfo));
     }
     displayMessageInDiv(statusMessage, statusFurtherInformation, messageType) {

package/src/Api/Implementation/TeamSharingApiImpl.js

@@ -22,12 +22,9 @@ class TeamSharingApiImpl extends ApiBase_1.ApiBase {
         const teamSharingOptions = this.getTeamSharingOptions();
         const sharedEntitiesContext = this.getAdaptableInternalApi().buildBaseContext();
         let loadedSharedEntities = await teamSharingOptions.loadSharedEntities(sharedEntitiesContext);
-        // with v15 we introduced 2 types of SharedEntity: AdaptableSharedEntity (basically the old one) and the new CustomSharedEntity
-        // for backwards compatibility, we add default the 'EntityType' property to 'adaptableEntity'
         loadedSharedEntities = loadedSharedEntities.map((sharedEntity) => {
             if (sharedEntity.EntityType !== 'adaptableEntity' &&
                 sharedEntity.EntityType !== 'customEntity') {
-                // @ts-ignore
                 sharedEntity.EntityType = 'adaptableEntity';
             }
             return sharedEntity;

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -34,7 +34,6 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
     getCustomIcons() {
         let customIconsProp = this.getUserInterfaceOptions().customIcons;
         if (customIconsProp != null) {
-            // first do the function then get hardcoded items
             return typeof customIconsProp === 'function'
                 ? customIconsProp()
                 : customIconsProp;

package/src/Api/Internal/ActionColumnInternalApi.js

@@ -50,7 +50,6 @@ class ActionColumnInternalApi extends ApiBase_1.ApiBase {
     }
     getActionColumnsAndButtons(colDef) {
         let actionColumn;
-        // this should probably be in FDC3 api...
         if (!actionColumn && this.getFdc3Api().internalApi.isFdc3MainActionColumn(colDef.colId)) {
             const actionButtons = this.getFdc3Api().internalApi.getButtonsForFdc3MainActionColumn();
             const actionColumnDefaultConfiguration = this.getFdc3Options().actionColumnDefaultConfiguration;

package/src/Api/Internal/AdaptableInternalApi.d.ts

@@ -19,7 +19,6 @@ import { ITeamSharingService } from '../../Utilities/Services/Interface/ITeamSha
 import { ButtonStyle } from '../../AdaptableState/Common/ButtonStyle';
 import { AdaptableButton } from '../../AdaptableState/Common/AdaptableButton';
 import { AdaptableFrameworkComponent } from '../../agGrid/AdaptableFrameworkComponent';
-import { IMetamodelService } from '../../Utilities/Services/Interface/IMetamodelService';
 import { IModuleCollection } from '../../Strategy/Interface/IModule';
 import { AdaptableObjectTag, AdaptableObjectWithScope } from '../../AdaptableState/Common/AdaptableObject';
 import { AdaptableForm, CellSummmaryInfo, FormContext, RowDataChangeTrigger, RowDataChangedInfo, AdaptableColumn, AdaptableColumnContext } from '../../../types';
@@ -73,7 +72,6 @@ export declare class AdaptableInternalApi extends ApiBase {
     getQueryLanguageService(): IQueryLanguageService;
     getAlertService(): IAlertService;
     getTeamSharingService(): ITeamSharingService;
-    getMetamodelService(): IMetamodelService;
     getRowFormService(): RowFormService;
     getFdc3Service(): Fdc3Service;
     getFlashingCellService(): FlashingCellService;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -17,7 +17,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getAdaptableJSXElement() {
         return this._adaptable._PRIVATE_adaptableJSXElement ?? null;
     }
-    // Popup Redux Actions
     showPopupConfirmation(confirmation) {
         this.dispatchAction(PopupRedux.PopupShowConfirmation(confirmation));
     }
@@ -110,9 +109,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getTeamSharingService() {
         return this._adaptable.TeamSharingService;
     }
-    getMetamodelService() {
-        return this._adaptable.MetamodelService;
-    }
     getRowFormService() {
         return this._adaptable.RowFormService;
     }
@@ -192,21 +188,18 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     isDocumentationLinksDisplayed() {
         return this.getUserInterfaceOptions().showDocumentationLinks;
     }
-    // the row data which is used to preview the expression evaluation (usually the first row data)
     getQueryPreviewData() {
         const firstRowNode = this.getGridApi().getFirstRowNode();
         if (firstRowNode == undefined) {
             return {};
         }
         const firstRowData = firstRowNode?.data ? { ...firstRowNode?.data } : {};
-        // handle CalcCols which are not persisted in the rowModel
         this.getCalculatedColumnApi()
             .getCalculatedColumns()
             .forEach((calculatedColumn) => {
             const columnRawValue = this._adaptable.api.gridApi.getRawValueFromRowNode(firstRowNode, calculatedColumn.ColumnId);
             firstRowData[calculatedColumn.ColumnId] = columnRawValue;
         });
-        // handle FreeTextCols which are not persisted in the rowModel
         this.getFreeTextColumnApi()
             .getFreeTextColumns()
             .forEach((freeTextColumn) => {
@@ -216,9 +209,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         return firstRowData;
     }
     createFrameworkComponent(containerDomNode, frameworkComponent, componentType) {
-        const createComponentFn = () => 
-        // delegate the logic to framework wrapper
-        this._adaptable._emitSync('FrameworkComponentChange', {
+        const createComponentFn = () => this._adaptable._emitSync('FrameworkComponentChange', {
             command: 'create',
             containerDomNode,
             frameworkComponent,
@@ -228,8 +219,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             createComponentFn();
         }
         else {
-            // adaptable may not be initialized yet if the framework component is part of the initial render
-            // AFL 2021.10.14 - not really sure if this is necessary anymore?! (see the other changes in this commit)
             (0, waitForCondition_1.waitForCondition)(() => this.isAdapTableReady()).then(() => {
                 createComponentFn();
             });
@@ -253,7 +242,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     }
     executeWithProgressIndicator(label, executeFn, errorHandlingFn) {
         this.getUserInterfaceApi().showProgressIndicator({ text: label, delay: 300 });
-        // setTimeout required to give the ProgressIndicator rendering a head-start (see RAF in ProgressIndicator implementation)
         setTimeout(() => {
             try {
                 executeFn();
@@ -293,7 +281,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             return userInterfaceOptions.objectTags;
         }
         if (typeof userInterfaceOptions.objectTags === 'function') {
-            // sanitize the provided tags, just to be sure that the user does NOT break the UI
             return userInterfaceOptions
                 .objectTags(this.buildBaseContext())
                 .filter((tag) => typeof tag === 'string');
@@ -318,24 +305,19 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
                 ...this.buildBaseContext(),
             };
             const customGeneratedTags = layoutOptions.layoutTagOptions.autoGenerateTagsForLayouts(autoGenerateTagsForLayoutsContext);
-            // sanitize the provided tags, just to be sure that the user does NOT break the UI
             return customGeneratedTags.filter((tag) => typeof tag === 'string');
         }
     }
-    // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);
     }
-    // doing it this way to avoid having to expose Module Params which is internal
     showSettingsPanel(module, moduleParams) {
         this.showModulePopup(module, moduleParams);
     }
     getLabelForTag(adaptableObjectTag) {
-        // not very interesting right now, but useful later when tag is not only a plain string
         return adaptableObjectTag;
     }
     getValueForTag(adaptableObjectTag) {
-        // not very interesting right now, but useful later when tag is not only a plain string
         return adaptableObjectTag;
     }
     getAdaptableQueryExpressionText(query) {
@@ -347,21 +329,14 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             ? this.getExpressionApi().getAdaptableQueryExpressionWithColumnFriendlyNames(query)
             : this.getExpressionApi().getAdaptableQueryExpression(query);
     }
-    /**
-     * Gets a value from a rowData object using a field name.
-     * Supports deep values (e.g. fieldName = 'address.street')
-     */
-    // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/utils/object.ts#L205
     getValueUsingField(rowData, fieldName) {
         if (!rowData || !fieldName?.length) {
             return;
         }
         const isColumnValueKeyNested = fieldName?.includes('.');
-        // if no '.', then it's not a deep value
         if (!isColumnValueKeyNested) {
             return rowData[fieldName];
         }
-        // otherwise it is a deep value, so need to dig for it
         const fields = fieldName.split('.');
         let currentObject = rowData;
         for (let i = 0; i < fields.length; i++) {
@@ -372,11 +347,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         }
         return currentObject;
     }
-    /**
-     * Sets a value in a rowData object using a field name.
-     * Supports deep values (e.g. fieldName = 'address.street')
-     */
-    // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/valueService/valueService.ts#L236
     setValueUsingField(rowData, fieldName, newValue) {
         if (!rowData || !fieldName?.length) {
             return;
@@ -384,27 +354,23 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         const isColumnValueKeyContainsDots = fieldName?.includes('.');
         let valuesAreSame = false;
         if (!isColumnValueKeyContainsDots) {
-            // soft comparison to match strings and numbers
             valuesAreSame = rowData[fieldName] == newValue;
             if (!valuesAreSame) {
                 rowData[fieldName] = newValue;
             }
         }
         else {
-            // otherwise it is a deep value, so need to dig for it
             const fieldPieces = fieldName.split('.');
             let currentObject = rowData;
             while (fieldPieces.length > 0 && currentObject) {
                 const fieldPiece = fieldPieces.shift();
                 if (fieldPieces.length === 0) {
-                    // soft comparison to match strings and numbers
                     valuesAreSame = currentObject[fieldPiece] == newValue;
                     if (!valuesAreSame) {
                         currentObject[fieldPiece] = newValue;
                     }
                 }
                 else {
-                    // NOTE AFL: this was NOT in the original AG Grid code, but we need it to handle inserting deep values (the original implementation only handled updating)
                     if (currentObject[fieldPiece] == null) {
                         currentObject[fieldPiece] = {};
                     }
@@ -419,15 +385,12 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             return [];
         }
         let locatedAdaptableObjects = [...specificAdaptableObjects];
-        // IDs are the most specific locators
         if (ids?.length) {
             locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => ids.includes(adaptableObject.Uuid));
         }
-        // secondly filter by Tags
         if (tag) {
             locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => adaptableObject.Tags?.includes(tag));
         }
-        // lastly filter by scope
         if (scope) {
             locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => this.getColumnScopeApi().isScopeInScope(adaptableObject.Scope, scope));
         }
@@ -456,7 +419,6 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     parseDateValue(dateValue) {
         const dateFormat = this.getUserInterfaceOptions().dateInputOptions.dateFormat;
         if (dateFormat === 'yyyy-MM-dd') {
-            // if the format is ISO, we don't pass it so that we use the date-fns `parseISO` which is more robust
             return (0, DateHelper_1.parseDateValue)(dateValue);
         }
         return (0, DateHelper_1.parseDateValue)(dateValue, dateFormat);

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) {