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

package/src/Api/Internal/LayoutInternalApi.js

@@ -11,18 +11,9 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectF
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
 class LayoutInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Compares 2 Layouts for equality
-     * @param layout1 First Layout
-     * @param layout2 Second Layout
-     */
     areLayoutsEqual(layout1, layout2) {
         return (0, LayoutHelpers_1.areLayoutsEqual)(layout1, layout2);
     }
-    /**
-     * Returns what the layout supports.
-     * This takes into account the data-source.
-     */
     getLayoutSupportedFeatures() {
         const layoutSupportedFeatures = {
             RowGroupedColumns: true,
@@ -35,7 +26,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
             RowSummaries: true,
         };
         if (this.getGridApi().isTreeDataGrid()) {
-            //  layoutSupportedFeatures.RowGroupedColumns = false;
             layoutSupportedFeatures.PivotColumns = false;
         }
         if (this.getGridApi().getAgGridRowModelType() === 'viewport') {
@@ -127,7 +117,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.default.IsNullOrEmpty(oldSorts) && ArrayExtensions_1.default.IsNullOrEmpty(newSorts)) {
             return [];
         }
-        // If either one is empty but not both, all columns in the non-empty array have changed
         if (ArrayExtensions_1.default.IsNullOrEmpty(oldSorts)) {
             return newSorts.map((sort) => sort.ColumnId);
         }
@@ -135,22 +124,17 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
             return oldSorts.map((sort) => sort.ColumnId);
         }
         const changedColumnIds = [];
-        // Create maps for quick lookup
         const oldSortsMap = new Map();
         oldSorts.forEach((sort) => {
             oldSortsMap.set(sort.ColumnId, sort.SortOrder);
         });
-        // Check columns in new sorts that changed from old sorts
         newSorts.forEach((newSort) => {
             const oldSortOrder = oldSortsMap.get(newSort.ColumnId);
-            // If column wasn't sorted before or sort order changed
             if (oldSortOrder === undefined || oldSortOrder !== newSort.SortOrder) {
                 changedColumnIds.push(newSort.ColumnId);
             }
-            // Remove processed columns from the map
             oldSortsMap.delete(newSort.ColumnId);
         });
-        // Add remaining columns from old sorts (these were removed in new sorts)
         oldSortsMap.forEach((_, columnId) => {
             changedColumnIds.push(columnId);
         });
@@ -197,7 +181,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         return result;
     }
     getCurrentLayout_perfOptimized() {
-        // perf-optimized version of getCurrentLayout()
         const layoutState = this.getAdaptableState().Layout;
         const currentLayoutName = layoutState.CurrentLayout;
         if (!currentLayoutName) {
@@ -213,7 +196,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         let allHaveFilter = true;
         let allHaveFloatingFilter = true;
         for (const column of groupedAgColumns) {
-            // Early exit: no need to continue if both are already false
             if (!allHaveFilter && !allHaveFloatingFilter) {
                 break;
             }

package/src/Api/Internal/NamedQueryInternalApi.js

@@ -5,10 +5,6 @@ const tslib_1 = require("tslib");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const ApiBase_1 = require("../Implementation/ApiBase");
 class NamedQueryInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Returns the name of all the referenced Named Queries as an array of strings
-     * @param expression query string
-     */
     getReferencedNamedQueryNames(expression = '') {
         try {
             return this.getAdaptableInternalApi()
@@ -16,16 +12,11 @@ class NamedQueryInternalApi extends ApiBase_1.ApiBase {
                 .getNamedQueryNamesFromExpression(expression);
         }
         catch (error) {
-            // defensive programing, this should happen only if someone botched Initial Adaptable State
             this.logWarn(`QueryApi.getReferencedNamedQueryNames received an invalid expression: ${expression}
                   Error: ${error}`);
             return [];
         }
     }
-    /**
-     * Returns all the references in the AdaptableState of the NamedQuery with the given name
-     * @param namedQueryName namedQuery name
-     */
     getNamedQueryModuleReferences(namedQueryName) {
         const references = [];
         this.getAdaptableInternalApi()

package/src/Api/Internal/PredicateInternalApi.js

@@ -9,9 +9,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     IsInOrNotInPredicateDef(predicateDef) {
         return predicateDef && ['In', 'NotIn'].includes(predicateDef.id);
     }
-    /**
-     * Get all Filter Predicate Definitions - System and Custom
-     */
     getFilterPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFilterPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('columnFilter'));
     }
@@ -42,9 +39,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFilterPredicates;
     }
-    /**
-     * Get all Alert Predicate Definitions - System and Custom
-     */
     getAlertPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemAlertPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('alert'));
     }
@@ -74,9 +68,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemBadgeStylePredicates;
     }
-    /**
-     * Get all Format Column Predicate Definitions - System and Custom
-     */
     getFormatColumnPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFormatColumnPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('formatColumn'));
     }
@@ -93,9 +84,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFormatColumnPredicates;
     }
-    /**
-     * Get all Flashing Cell Predicate Definitions - System and Custom
-     */
     getFlashingCellPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFlashingCellPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('flashingcell'));
     }
@@ -112,10 +100,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFlashingCellPredicates;
     }
-    /**
-     * Gets the correct Equality-type System Predicate for a particular DataType
-     * @param dataType DataType of Column
-     */
     getEqualityPredicateForDataType(dataType) {
         let predicateId;
         switch (dataType) {
@@ -134,16 +118,9 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return predicateId;
     }
-    /**
-     * Get all Badge Style Predicate Definitions - System and Custom
-     */
     getBadgeStylePredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemBadgeStylePredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('badgeStyle'));
     }
-    /**
-     * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
-     * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)
-     */
     mergeSystemAndCustomPredicates(systemDefs, customDefs) {
         const systemDefsToUse = systemDefs.map((systemDef) => {
             const customDef = customDefs.find((customDef) => customDef.id === systemDef.id);

package/src/Api/Internal/RowFormInternalApi.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RowFormInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class RowFormInternalApi extends ApiBase_1.ApiBase {
-    // Row Form Methods
     async buildRowEditForm(rowNode) {
         return this.buildRowForm('rowEdited', rowNode);
     }
@@ -46,11 +45,9 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             : rowFormOptions.rowFormDescription;
     }
     buidRowFormButtons(type, rowNode, formFields) {
-        // 1. check if there are custom user provided buttons
         if (Array.isArray(this.getRowFormOptions().rowFormButtons)) {
             return this.getRowFormOptions().rowFormButtons;
         }
-        // 2. else return the standard ones
         const cancelButton = {
             label: 'Cancel',
             buttonStyle: {
@@ -64,19 +61,11 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
                 variant: 'raised',
                 tone: 'success',
             },
-            // The form component enriches every button's context with
-            // `formIsValid`. When no validation is configured this is always
-            // `true`, so the existing UX is unchanged - but consumers who supply
-            // `required` / `validate` / `min` / `max` / `pattern` via
-            // `rowFormField` automatically get a Save button that disables on
-            // invalid input.
             disabled: (_button, context) => {
                 const formIsValid = context.formIsValid;
                 return formIsValid === false;
             },
             onClick: (button, context) => {
-                // textOutput should not be saved, their values are set to display values
-                // we need to filter out the textOutput fields and add the primaryKey
                 const eventInfo = type === 'rowCreated'
                     ? {
                         type: 'rowCreated',
@@ -97,7 +86,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
         return [cancelButton, saveButton];
     }
     prepareCreateData(formFields, context) {
-        // when creating we just omit values that are not set
         const dataToSave = { ...context.formData };
         for (const formField of formFields) {
             if (dataToSave[formField.name] === '') {
@@ -121,7 +109,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
         const relevantColumns = this.getColumnApi()
             .getUIAvailableColumns()
             .filter((column) => {
-            // if there is NO rowNode, do NOT display the non-editable fields as they will be empty
             return !!rowNode || this.isCellEditable(column, rowNode);
         })
             .filter((column) => this.showColumnInRowForm(column, rowFormType));
@@ -168,10 +155,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             fieldType,
             options: fieldValueOptions,
         };
-        // Allow consumers to override any subset of the auto-built field via
-        // `rowFormOptions.rowFormField`. We deliberately preserve `name` so a
-        // field always identifies itself by its column id - any attempt to
-        // rename would desync the form data from the underlying grid column.
         const overrideFn = this.getRowFormOptions().rowFormField;
         if (typeof overrideFn === 'function') {
             const override = overrideFn(this.buildFormFieldLabelContext(type, column, rowNode));
@@ -204,7 +187,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             case 'number':
                 return 'number';
             default:
-                // everything else is a plain text input
                 return 'text';
         }
     }

package/src/Api/Internal/StateInternalApi.js

@@ -7,21 +7,6 @@ class StateInternalApi extends ApiBase_1.ApiBase {
     getAllStateForDevTools() {
         let allState = this.getAdaptableApi().stateApi.getAllState();
         if (allState.Layout && Array.isArray(allState.Layout.Layouts)) {
-            /**
-             * For devtools, we want to be able to restore states
-             * but some layouts may not have column sizing defined for
-             * some cols, and they will default to 200px
-             *
-             * but we need to send the state with the sizes computed,
-             * because on restore, in LayoutManager, if ColumnSizing[colId]
-             * has no value, it will leave the column width in the current state
-             * which is not what we want - if in the meantime the column was resized
-             *
-             * Therefore, we need to adjust the state and make sure
-             * all columns have a width set explicitly in the layout
-             *
-             * TODO make sure also pivot layouts are handled
-             */
             allState = { ...allState };
             allState.Layout = { ...allState.Layout };
             allState.Layout.Layouts = allState.Layout.Layouts.map((layout) => {
@@ -43,10 +28,6 @@ class StateInternalApi extends ApiBase_1.ApiBase {
         }
         return allState;
     }
-    /**
-     * Replaces persisted Adaptable state with the supplied snapshot (e.g. from DevTools).
-     * Transient store sections (Internal, Popup, Comment, Plugins) are left unchanged.
-     */
     restoreState(state) {
         return new Promise((resolve, reject) => {
             this.getAdaptableInternalApi().executeWithProgressIndicator('Restoring state from DevTools...', () => {
@@ -61,12 +42,6 @@ class StateInternalApi extends ApiBase_1.ApiBase {
                         ? JSON.parse(JSON.stringify(state))
                         : (0, AdaptableStore_1.getPersistableState)(JSON.parse(JSON.stringify(state)));
                     let processedState = this._adaptable.normalizeAdaptableState(clonedState, agGridOptions);
-                    // processedState = getPersistableState(
-                    //   this.getOptions().stateOptions.applyState(
-                    //     processedState,
-                    //     buildAdaptableStateFunctionConfig(this._adaptable)
-                    //   )
-                    // );
                     this.getAdaptableStore().TheStore.dispatch((0, AdaptableStore_1.LoadState)(processedState));
                     this.getAdaptableStore().TheStore.dispatch((0, AdaptableStore_1.InitState)());
                     this._adaptable.refreshLayout();

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -14,14 +14,6 @@ const DYNAMIC_RANGE_ENDPOINTS = [
 const isDynamicRangeEndpoint = (value) => typeof value === 'string' &&
     DYNAMIC_RANGE_ENDPOINTS.includes(value);
 class StyledColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Creates a sparkline described by `options` in its target container and
-     * returns the chart instance (used to update / destroy it).
-     *
-     * Centralises sparkline creation so view components don't import
-     * `ag-charts-enterprise` directly: the `createSparkline` factory is sourced
-     * from the AG Grid Sparklines module via the grid's registry bean.
-     */
     createSparkline(options) {
         if (!this.getStyledColumnApi().canDisplaySparklines()) {
             this.logWarn('Cannot render Sparkline: AG Grid Sparklines are not enabled. Register the AG Grid Sparklines module (e.g. `AllEnterpriseModule.with(AgChartsEnterpriseModule)`) to use Sparklines.');
@@ -58,12 +50,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return this._adaptable.getMinMaxCachedValueForColumn(column, 'median');
     }
-    /**
-     * Gets the Minimum Value to display for a Styled Column
-     * @param styledColumn Styled Column to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
-     */
     getNumericStyleMinValue(styledColumn, column, rowNode, cellValue) {
         const columnComparison = styledColumn.GradientStyle?.ColumnComparison ??
             styledColumn.PercentBarStyle?.ColumnComparison ??
@@ -82,7 +68,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
                 }
             }
         }
-        // for Gradient Column we want just the range that contains cell value
         if (styledColumn.GradientStyle) {
             const gs = styledColumn.GradientStyle;
             const ranges = (0, GradientStyleHelper_1.expandGradientCellRanges)(gs);
@@ -90,42 +75,24 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             const range = this.findRangeForColumn(ranges, column, lookupType, cellValue);
             return this.getCellColorRangeMinValue(range, column, lookupType);
         }
-        // for percentbar we want to get the whole Ranges
         if (styledColumn.PercentBarStyle) {
             const ranges = styledColumn.PercentBarStyle?.CellRanges;
             if (ranges) {
                 return this.getCellColorRangeMinValue(ranges[0], column, styledColumn.PercentBarStyle.RangeValueType);
             }
         }
-        // for bullet chart, treat the bands the same way as percent bar
         if (styledColumn.BulletChartStyle) {
             const ranges = styledColumn.BulletChartStyle?.CellRanges;
             if (ranges && ranges.length > 0) {
                 return this.getCellColorRangeMinValue(ranges[0], column, styledColumn.BulletChartStyle.RangeValueType);
             }
-            // No bands defined - fall back to the column's own min so the bar
-            // can still scale across its natural range.
             return this.getMinValueForNumericColumn(column);
         }
     }
-    /**
-     * Returns last range that matches the cell value.
-     *
-     * @param cellRanges
-     * @param column
-     * @param rangeValueType
-     * @param cellValue
-     */
     findRangeForColumn(cellRanges, column, rangeValueType, cellValue) {
         if (!cellRanges || cellRanges.length === 0) {
             return null;
         }
-        // Walk forward and take the **first** matching band. The Ranges UI emits
-        // contiguous bands where `prev.Max === next.Min` (e.g. `[1,5]` and `[5,10]`),
-        // so the shared boundary number is in both ranges. First-match-wins means a
-        // boundary value belongs to the *lower* range — i.e. it sits at the high end
-        // of that range (`t=1`, alpha=MaxAlpha → fully visible) rather than at the
-        // bottom of the next one (`t=0`, alpha=MinAlpha → typically invisible).
         for (let i = 0; i < cellRanges.length; i++) {
             const cellRange = cellRanges[i];
             const minRange = this.getCellColorRangeMinValue(cellRange, column, rangeValueType);
@@ -136,12 +103,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return null;
     }
-    /**
-     * Gets the Maximum Value to display for a Styled Column
-     * @param styledColumn Styled Column to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
-     */
     getNumericStyleMaxValue(styledColumn, column, rowNode, cellValue) {
         const columnComparison = styledColumn.GradientStyle?.ColumnComparison ??
             styledColumn.PercentBarStyle?.ColumnComparison ??
@@ -181,11 +142,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             return this.getMaxValueForNumericColumn(column);
         }
     }
-    /**
-     * Returns the smallest number in a Range
-     * @param range Range to check
-     * @param column current Column
-     */
     getCellColorRangeMinValue(range, column, rangeValueType) {
         if (!range) {
             return undefined;
@@ -216,11 +172,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return minValue;
     }
-    /**
-     * Returns the largest number in a Range
-     * @param range Range to check
-     * @param column current Column
-     */
     getCellColorRangeMaxValue(range, column, rangeValueType) {
         if (!range) {
             return undefined;
@@ -251,10 +202,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return maxValue;
     }
-    /**
-     * Retrieves the ColumnComparison property, if there, from a Styled Column
-     * @param styledColumn Styled Column to Add
-     */
     getColumnComparisonForStyledColumn(styledColumn) {
         if (styledColumn.GradientStyle?.ColumnComparison) {
             return styledColumn.GradientStyle.ColumnComparison;
@@ -267,10 +214,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return undefined;
     }
-    /**
-     * Returns any ColumnIds referenced in a Column Comparison
-     * @param columnComparision Column Comparison to check
-     */
     getColumnIdsFromColumnComparison(columnComparison) {
         let returnValues = [];
         if (typeof columnComparison.MinValue === 'string') {
@@ -295,10 +238,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             return [columnId];
         }
     }
-    /**
-     * Checks if the styled column has a range with a relative value
-     * @param styledColumn Styled Column to Add
-     */
     hasStyledColumnRelativeCellRange(styledColumn) {
         let cellColorRange = null;
         let rangeValueType = 'Number';
@@ -340,7 +279,6 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         if (!badgeStyle.Badges.length) {
             return null;
         }
-        // first that matches, sort last ones without predicate
         const badgesWithoutAll = [];
         const badgesWithAll = [];
         for (let badge of badgeStyle.Badges) {

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -3,32 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TeamSharingInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class TeamSharingInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Retrieves shared entry dependencies.
-     */
     getSharedEntryDependencies(sharedEntity) {
         const allEntities = this.getTeamSharingApi().getLoadedAdaptableSharedEntities();
         return (sharedEntity?.EntityDependencyIds ?? []).map((id) => allEntities.find((entity) => entity.Uuid === id));
     }
     waitForTeamSharingImportEnd() {
-        // we have no deterministic means to ensure the teamsharing import is finished (because the import actions are opaque and may have side-effects)
-        // therefore we will listen for state changes and
-        // if the state was unchanged in the last `waitForStableState` ms, we assume/hope the import is finished
         const waitForStableState = 1000;
         const waitThreshold = 5000;
         return new Promise((resolve, reject) => {
             let pollTimer;
-            // stop the poll after `waitThreshold` ms, if the state hasn't stabilised until now, it probably never will...
             let breakTimer = setTimeout(() => {
                 unsubscribe?.();
                 clearTimeout(pollTimer);
                 reject(false);
             }, waitThreshold);
-            // poll state for changes:
             const unsubscribe = this.getEventApi().on('AdaptableStateChanged', () => {
                 clearTimeout(pollTimer);
                 pollTimer = setTimeout(() => {
-                    // state is stable, cleanup all subscriptions before returning
                     unsubscribe();
                     clearTimeout(breakTimer);
                     resolve(true);

package/src/Redux/ActionsReducers/AlertRedux.js

@@ -5,38 +5,14 @@ const tslib_1 = require("tslib");
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
 const utils_1 = require("./utils");
-/**
- * @ReduxAction An Alert Definition has been added
- */
 exports.ALERT_DEFINITION_ADD = 'ALERT_DEFINITION_ADD';
-/**
- * @ReduxAction An Alert Definition has been edited
- */
 exports.ALERT_DEFINITION_EDIT = 'ALERT_DEFINITION_EDIT';
-/**
- * @ReduxAction An Alert Definition has been deleted
- */
 exports.ALERT_DEFINITION_DELETE = 'ALERT_DEFINITION_DELETE';
-/**
- * @ReduxAction Alert Definition is suspended
- */
 exports.ALERT_DEFINITION_SUSPEND = 'ALERT_DEFINITION_SUSPEND';
-/**
- * @ReduxAction Alert Definition is unsuspended, or activated
- */
 exports.ALERT_DEFINITION_UNSUSPEND = 'ALERT_DEFINITION_UNSUSPEND';
-/**
- * @ReduxAction All Alert Definitions are suspended
- */
 exports.ALERT_DEFINITION_SUSPEND_ALL = 'ALERT_DEFINITION_SUSPEND_ALL';
-/**
- * @ReduxAction All Alert Definitions are unsuspended, or activated
- */
 exports.ALERT_DEFINITION_UNSUSPEND_ALL = 'ALERT_DEFINITION_UNSUSPEND_ALL';
 exports.ALERT_CLEAR_FLASHING_CELLS = 'ALERT_CLEAR_FLASHING_CELLS';
-/**
- * @ReduxAction Alert Module is ready
- */
 exports.ALERT_READY = 'ALERT_READY';
 const AlertDefinitionAdd = (alertDefinition) => ({
     type: exports.ALERT_DEFINITION_ADD,

package/src/Redux/ActionsReducers/ApplicationRedux.js

@@ -2,17 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApplicationReducer = exports.ApplicationDataEntryDelete = exports.ApplicationDataEntryEdit = exports.ApplicationDataEntryAdd = exports.APPLICATION_DATA_ENTRY_DELETE = exports.APPLICATION_DATA_ENTRY_EDIT = exports.APPLICATION_DATA_ENTRY_ADD = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
-/**
- * @ReduxAction An Application Data Entry has been added
- */
 exports.APPLICATION_DATA_ENTRY_ADD = 'APPLICATION_DATA_ENTRY_ADD';
-/**
- * @ReduxAction An Application Data Entry has been edited
- */
 exports.APPLICATION_DATA_ENTRY_EDIT = 'APPLICATION_DATA_ENTRY_EDIT';
-/**
- * @ReduxAction An Application Data Entry has been deleted
- */
 exports.APPLICATION_DATA_ENTRY_DELETE = 'APPLICATION_DATA_ENTRY_DELETE';
 const ApplicationDataEntryAdd = (applicationDataEntry) => ({
     type: exports.APPLICATION_DATA_ENTRY_ADD,

package/src/Redux/ActionsReducers/BulkUpdateRedux.js

@@ -1,13 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BulkUpdateReady = exports.BulkUpdateApply = exports.BULK_UPDATE_READY = exports.BULK_UPDATE_APPLY = void 0;
-/**
- * @ReduxAction Bulk Update is being applied
- */
 exports.BULK_UPDATE_APPLY = 'BULK_UPDATE_APPLY';
-/**
- * @ReduxAction Bulk Update Module is ready
- */
 exports.BULK_UPDATE_READY = 'BULK_UPDATE_READY';
 const BulkUpdateApply = (bypassValidationWarnings) => ({
     type: exports.BULK_UPDATE_APPLY,

package/src/Redux/ActionsReducers/CalculatedColumnRedux.js

@@ -4,21 +4,9 @@ exports.CalculatedColumnReducer = exports.CalculatedColumnReady = exports.Calcul
 const tslib_1 = require("tslib");
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
-/**
- * @ReduxAction A Calculated Column has been added
- */
 exports.CALCULATED_COLUMN_ADD = 'CALCULATED_COLUMN_ADD';
-/**
- * @ReduxAction A Calculated Column has been edited
- */
 exports.CALCULATED_COLUMN_EDIT = 'CALCULATED_COLUMN_EDIT';
-/**
- * @ReduxAction A Calculated Column has been deleted
- */
 exports.CALCULATED_COLUMN_DELETE = 'CALCULATED_COLUMN_DELETE';
-/**
- * @ReduxAction Calculated Column Module is ready
- */
 exports.CALCULATED_COLUMN_READY = 'CALCULATED_COLUMN_READY';
 const CalculatedColumnAdd = (calculatedColumn) => ({
     type: exports.CALCULATED_COLUMN_ADD,
@@ -54,16 +42,13 @@ const CalculatedColumnReducer = (state = initialState, action) => {
             calculatedColumns.push(actionCalculatedColumn);
             return { ...state, CalculatedColumns: calculatedColumns };
         }
-        // !! MUTABLE STATE
         case exports.CALCULATED_COLUMN_EDIT: {
             const actionCalculatedColumn = action
                 .calculatedColumn;
             return {
                 ...state,
                 CalculatedColumns: state.CalculatedColumns.map((abObject) => abObject.Uuid === actionCalculatedColumn.Uuid
-                    ? // we need to assign and return the same object
-                        // in order to make working with aggrid easier, as the col getter
-                        // references this object
+                    ?
                         Object.assign(abObject, actionCalculatedColumn)
                     : abObject),
             };

package/src/Redux/ActionsReducers/ChartingRedux.js

@@ -3,37 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartingReducer = exports.ChartingGetExternalChartDefinitions = exports.ChartingGetChartModels = exports.initialState = exports.ChartingDeleteExternalChart = exports.ChartingAddExternalChart = exports.ChartingEditExternalChart = exports.ChartingDeleteChart = exports.ChartingAddChart = exports.ChartingEditChart = exports.ChartingReady = exports.ChartingSetChartModels = exports.CHARTING_DELETE_EXTERNAL_CHART = exports.CHARTING_ADD_EXTERNAL_CHART = exports.CHARTING_EDIT_EXTERNAL_CHART = exports.CHARTING_DELETE_CHART = exports.CHARTING_ADD_CHART = exports.CHARTING_EDIT_CHART = exports.CHARTING_READY = exports.SET_CHARTING_CHARTS = void 0;
 const Uuid_1 = require("../../AdaptableState/Uuid");
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
-/**
- * @ReduxAction Set AG Grid Charting Models
- */
 exports.SET_CHARTING_CHARTS = 'SET_CHARTING_CHARTS';
-/**
- * @ReduxAction Charting Module is ready
- */
 exports.CHARTING_READY = 'CHARTING_READY';
-/**
- * @ReduxAction Edit chart definition
- */
 exports.CHARTING_EDIT_CHART = 'CHARTING_EDIT_CHART';
-/**
- * @ReduxAction Add chart definition
- */
 exports.CHARTING_ADD_CHART = 'CHARTING_ADD_CHART';
-/**
- * @ReduxAction Deelte chart definition
- */
 exports.CHARTING_DELETE_CHART = 'CHARTING_DELETE_CHART';
-/**
- * @ReduxAction Edit chart definition
- */
 exports.CHARTING_EDIT_EXTERNAL_CHART = 'CHARTING_EDIT_EXTERNAL_CHART';
-/**
- * @ReduxAction Add chart definition
- */
 exports.CHARTING_ADD_EXTERNAL_CHART = 'CHARTING_ADD_EXTERNAL_CHART';
-/**
- * @ReduxAction Deelte chart definition
- */
 exports.CHARTING_DELETE_EXTERNAL_CHART = 'CHARTING_DELETE_EXTERNAL_CHART';
 const ChartingSetChartModels = (charts) => ({
     charts,