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

package/src/Redux/ActionsReducers/NoteRedux.js

@@ -4,21 +4,9 @@ exports.NoteReducer = exports.GetNoteSelector = exports.GetAllNotesSelector = ex
 const tslib_1 = require("tslib");
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
-/**
- * @ReduxAction A Note has been added
- */
 exports.NOTE_ADD = 'NOTE_ADD';
-/**
- * @ReduxAction A Note has been edited
- */
 exports.NOTE_EDIT = 'NOTE_EDIT';
-/**
- * @ReduxAction A Note has been deleted
- */
 exports.NOTE_DELETE = 'NOTE_DELETE';
-/**
- * @ReduxAction Note Module is ready
- */
 exports.NOTE_READY = 'NOTE_READY';
 const NoteAdd = (note) => ({
     type: exports.NOTE_ADD,
@@ -48,10 +36,8 @@ const GetNoteSelector = (state, address) => {
     }
     return (state?.Notes ?? []).find((note) => {
         if (note.PrimaryKeyValue === address.PrimaryKeyValue && note.ColumnId === address.ColumnId) {
-            // happy check
             return true;
         }
-        // Primary keys retrieved from the grid dom are always strings, so we must also consider them strings
         if ((typeof address.PrimaryKeyValue === 'number' && typeof note.PrimaryKeyValue === 'string') ||
             (typeof address.PrimaryKeyValue === 'string' && typeof note.PrimaryKeyValue === 'number')) {
             return (note.PrimaryKeyValue.toString() === address.PrimaryKeyValue.toString() &&

package/src/Redux/ActionsReducers/PluginsRedux.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginsReducer = exports.PluginsSetPluginState = exports.OPENFIN_SET_CURRENT_REPORTNAME = exports.OPENFIN_SET_RUNNING_OFF = exports.OPENFIN_SET_RUNNING_ON = exports.OPENFIN_SET_AVAILABLE_OFF = exports.OPENFIN_SET_AVAILABLE_ON = exports.OPENFIN_LIVE_REPORT_CLEAR = exports.OPENFIN_LIVE_REPORT_SET = exports.OPENFIN_STOP_LIVE_DATA = exports.OPENFIN_START_LIVE_DATA = exports.IPUSHPULL_SET_AVAILABLE_PAGES = exports.IPUSHPULL_SET_CURRENT_PAGE = exports.IPUSHPULL_SET_CURRENT_FOLDER = exports.IPUSHPULL_SET_CURRENT_REPORTNAME = exports.IPUSHPULL_DOMAIN_PAGES_CLEAR = exports.IPUSHPULL_DOMAIN_PAGES_SET = exports.IPUSHPULL_LIVE_REPORT_CLEAR = exports.IPUSHPULL_LIVE_REPORT_SET = exports.IPUSHPULL_SET_RUNNING_OFF = exports.IPUSHPULL_SET_RUNNING_ON = exports.IPUSHPULL_SET_AVAILABLE_OFF = exports.IPUSHPULL_SET_AVAILABLE_ON = exports.IPUSHPULL_SET_LOGIN_DETAILS = exports.IPUSHPULL_SET_LOGIN_ERROR_MESSAGE = exports.IPUSHPULL_LOGOUT = exports.IPUSHPULL_LOGIN = exports.IPUSHPULL_ADD_PAGE = exports.IPUSHPULL_STOP_LIVE_DATA = exports.IPUSHPULL_START_LIVE_DATA = exports.IPUSHPULL_REPORT_SELECT = exports.IPUSHPULL_SEND_SNAPSHOT = exports.IPUSHPULL_SET_THROTTLE_TIME = exports.PLUGINS_SET_PLUGIN_STATE = void 0;
-/**
- * @ReduxAction Plugins have been instantiated
- */
 exports.PLUGINS_SET_PLUGIN_STATE = 'PLUGINS_SET_PLUGIN_STATE';
 exports.IPUSHPULL_SET_THROTTLE_TIME = 'IPUSHPULL_SET_THROTTLE_TIME';
 exports.IPUSHPULL_SEND_SNAPSHOT = 'IPUSHPULL_SEND_SNAPSHOT';

package/src/Redux/ActionsReducers/PlusMinusRedux.js

@@ -5,49 +5,16 @@ 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 A Plus Minus Rule has been applied
- */
 exports.PLUS_MINUS_APPLY = 'PLUS_MINUS_APPLY';
-/**
- * @ReduxAction A Plus Minus Rule has been added
- */
 exports.PLUS_MINUS_RULE_ADD = 'PLUS_MINUS_RULE_ADD';
-/**
- * @ReduxAction A Plus Minus Rule has been edited
- */
 exports.PLUS_MINUS_RULE_EDIT = 'PLUS_MINUS_RULE_EDIT';
-/**
- * @ReduxAction A Plus Minus Rule has been deleted
- */
 exports.PLUS_MINUS_RULE_DELETE = 'PLUS_MINUS_RULE_DELETE';
-/**
- * @ReduxAction A Plus Minus Rule has been suspended
- */
 exports.PLUS_MINUS_RULE_SUSPEND = 'PLUS_MINUS_RULE_SUSPEND';
-/**
- * @ReduxAction A Plus Minus Rule has been unsuspended
- */
 exports.PLUS_MINUS_RULE_UNSUSPEND = 'PLUS_MINUS_RULE_UNSUSPEND';
-/**
- * @ReduxAction All Plus Minus Rules have been suspended
- */
 exports.PLUS_MINUS_RULE_SUSPEND_ALL = 'PLUS_MINUS_RULE_SUSPEND_ALL';
-/**
- * @ReduxAction All Plus Minus Rules have been unsuspended
- */
 exports.PLUS_MINUS_RULE_UNSUSPEND_ALL = 'PLUS_MINUS_RULE_UNSUSPEND_ALL';
-/**
- * @ReduxAction A Plus Minus Rule has been moved up
- */
 exports.PLUS_MINUS_RULE_MOVE_UP = 'PLUS_MINUS_RULE_MOVE_UP';
-/**
- * @ReduxAction A Plus Minus Rule has been moved down
- */
 exports.PLUS_MINUS_RULE_MOVE_DOWN = 'PLUS_MINUS_RULE_MOVE_DOWN';
-/**
- * @ReduxAction PlusMinus Module is ready
- */
 exports.PLUS_MINUS_READY = 'PLUS_MINUS_READY';
 const PlusMinusApply = (cellUpdateRequests) => ({
     type: exports.PLUS_MINUS_APPLY,
@@ -109,7 +76,6 @@ const PlusMinusReducer = (state = initialState, action) => {
     let plusMinusNudges;
     switch (action.type) {
         case exports.PLUS_MINUS_APPLY:
-            //we apply logic in the middleware since it's an Api call
             return Object.assign({}, state);
         case exports.PLUS_MINUS_RULE_ADD: {
             const actionPlusMinusNudge = action.plusMinusNudge;

package/src/Redux/ActionsReducers/PopupRedux.js

@@ -183,7 +183,6 @@ const PopupReducer = (state = initialState, action) => {
             return Object.assign({}, state, { PromptPopup: newPromptPopup });
         }
         case exports.POPUP_CONFIRM_PROMPT: {
-            //we dispatch the Action of ConfirmAction in the middelware in order to keep the reducer pure
             let newPromptPopup = {
                 ShowPromptPopup: false,
                 Header: '',
@@ -212,7 +211,6 @@ const PopupReducer = (state = initialState, action) => {
         }
         case exports.POPUP_CONFIRM_CONFIRMATION: {
             let actionTyped = action;
-            //we dispatch the Action of ConfirmAction in the middelware in order to keep the reducer pure
             let newConfirmationPopup = {
                 ShowConfirmationPopup: false,
                 Msg: '',
@@ -223,14 +221,13 @@ const PopupReducer = (state = initialState, action) => {
                 CancelAction: null,
                 ShowInputBox: false,
                 ConfirmationComment: actionTyped.comment,
-                MessageType: null, // ???
+                MessageType: null,
             };
             return Object.assign({}, state, {
                 ConfirmationPopup: newConfirmationPopup,
             });
         }
         case exports.POPUP_CANCEL_CONFIRMATION: {
-            //we dispatch the Action of CancelAction in the middleware in order to keep the reducer pure
             let newConfirmationPopup = {
                 ShowConfirmationPopup: false,
                 Msg: '',
@@ -266,7 +263,6 @@ const PopupReducer = (state = initialState, action) => {
                 FactoryId: showWindowAction.FactoryId,
             };
             let PopupList = [...state.WindowPopup.PopupList];
-            // Prevent opening the same popup twice
             if (state.WindowPopup.PopupList.some((windowPopup) => windowPopup.Id === windowSettings.Id)) {
                 PopupList = PopupList.map((windowPopup) => {
                     if (windowPopup.Id !== windowSettings.Id) {
@@ -274,7 +270,7 @@ const PopupReducer = (state = initialState, action) => {
                     }
                     return {
                         ...windowPopup,
-                        ...windowSettings, // props may have changed
+                        ...windowSettings,
                     };
                 });
             }

package/src/Redux/ActionsReducers/QuickSearchRedux.js

@@ -16,25 +16,10 @@ exports.QUICK_SEARCH_DEFAULT_CURRENT_TEXT_MATCH_STYLE = {
     ForeColor: ReduxConstants_1.QUICK_SEARCH_DEFAULT_FORE_COLOR,
     FontWeight: 'Bold',
 };
-/**
- * @ReduxAction Runs Quick Search
- */
 exports.QUICK_SEARCH_RUN = 'QUICK_SEARCH_RUN';
-/**
- * @ReduxAction Sets Quick Search whole-cell style (SSRM / legacy)
- */
 exports.QUICK_SEARCH_SET_CELL_MATCHING_STYLE = 'QUICK_SEARCH_SET_CELL_MATCHING_STYLE';
-/**
- * @ReduxAction Sets Quick Search matched-text style (AG Grid Find)
- */
 exports.QUICK_SEARCH_SET_TEXT_MATCHING_STYLE = 'QUICK_SEARCH_SET_TEXT_MATCHING_STYLE';
-/**
- * @ReduxAction Sets Quick Search active-match text style (AG Grid Find)
- */
 exports.QUICK_SEARCH_SET_CURRENT_TEXT_MATCHING_STYLE = 'QUICK_SEARCH_SET_CURRENT_TEXT_MATCHING_STYLE';
-/**
- * @ReduxAction Quick Search Module is ready
- */
 exports.QUICK_SEARCH_READY = 'QUICK_SEARCH_READY';
 const QuickSearchRun = (quickSearchText) => ({
     type: exports.QUICK_SEARCH_RUN,

package/src/Redux/ActionsReducers/ShortcutRedux.js

@@ -5,37 +5,13 @@ 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 A Shortcut has been added
- */
 exports.SHORTCUT_ADD = 'SHORTCUT_ADD';
-/**
- * @ReduxAction A Shortcut has been edited
- */
 exports.SHORTCUT_EDIT = 'SHORTCUT_EDIT';
-/**
- * @ReduxAction A Shortcut has been deleted
- */
 exports.SHORTCUT_DELETE = 'SHORTCUT_DELETE';
-/**
- * @ReduxAction A Shortcut has been suspended
- */
 exports.SHORTCUT_SUSPEND = 'SHORTCUT_SUSPEND';
-/**
- * @ReduxAction A Shortcut has been unsuspended or activated
- */
 exports.SHORTCUT_UNSUSPEND = 'SHORTCUT_UNSUSPEND';
-/**
- * @ReduxAction All Shortcuts have been suspended
- */
 exports.SHORTCUT_SUSPEND_ALL = 'SHORTCUT_SUSPEND_ALL';
-/**
- * @ReduxAction All Shortcuts have been unsuspended or activated
- */
 exports.SHORTCUT_UNSUSPEND_ALL = 'SHORTCUT_UNSUSPEND_ALL';
-/**
- * @ReduxAction Shortcut Module is ready
- */
 exports.SHORTCUT_READY = 'SHORTCUT_READY';
 const ShortcutAdd = (shortcut) => ({
     type: exports.SHORTCUT_ADD,

package/src/Redux/ActionsReducers/SmartEditRedux.js

@@ -1,13 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SmartEditReady = exports.SmartEditApply = exports.SMART_EDIT_READY = exports.SMART_EDIT_APPLY = void 0;
-/**
- * @ReduxAction Smart Edit is being applied
- */
 exports.SMART_EDIT_APPLY = 'SMART_EDIT_APPLY';
-/**
- * @ReduxAction SmartEdit Module is ready
- */
 exports.SMART_EDIT_READY = 'SMART_EDIT_READY';
 const SmartEditApply = (bypassValidationWarnings) => ({
     type: exports.SMART_EDIT_APPLY,

package/src/Redux/ActionsReducers/StatusBarRedux.js

@@ -2,13 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatusBarReducer = exports.StatusBarReady = exports.getStatusPanelsSelector = exports.initialState = exports.StatusBarSetPanels = exports.STATUS_BAR_READY = exports.SET_STATUS_BAR_PANELS = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
-/**
- * @ReduxAction Sets Status Bar panels
- */
 exports.SET_STATUS_BAR_PANELS = 'SET_STATUS_BAR_PANELS';
-/**
- * @ReduxAction AdapTable Status Bar is ready
- */
 exports.STATUS_BAR_READY = 'STATUS_BAR_READY';
 const StatusBarSetPanels = (statusPanels) => ({
     statusPanels: statusPanels,

package/src/Redux/ActionsReducers/StyledColumnRedux.js

@@ -5,41 +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 A Special Column Style has been added
- */
 exports.STYLED_COLUMN_ADD = 'STYLED_COLUMN_ADD';
-/**
- * @ReduxAction A Special Column Style has been edited
- */
 exports.STYLED_COLUMN_EDIT = 'STYLED_COLUMN_EDIT';
-/**
- * @ReduxAction A Special Column Style has been deleted
- */
 exports.STYLED_COLUMN_DELETE = 'STYLED_COLUMN_DELETE';
-/**
- * @ReduxAction Delete ALL Styled Columns
- */
 exports.STYLED_COLUMN_DELETE_ALL = 'STYLED_COLUMN_DELETE_ALL';
-/**
- * @ReduxAction StyledColumn Module is ready
- */
 exports.STYLED_COLUMN_READY = 'STYLED_COLUMN_READY';
-/**
- * @ReduxAction StyledColumn Module is suspended
- */
 exports.STYLED_COLUMN_SUSPEND = 'STYLED_COLUMN_SUSPEND';
-/**
- * @ReduxAction StyledColumn Module is unsuspended, or activated
- */
 exports.STYLED_COLUMN_UNSUSPEND = 'STYLED_COLUMN_UNSUSPEND';
-/**
- * @ReduxAction All StyledColumn Modules are suspended
- */
 exports.STYLED_COLUMN_SUSPEND_ALL = 'STYLED_COLUMN_SUSPEND_ALL';
-/**
- * @ReduxAction All StyledColumn Modules are unsuspended, or activated
- */
 exports.STYLED_COLUMN_UNSUSPEND_ALL = 'STYLED_COLUMN_UNSUSPEND_ALL';
 const StyledColumnAdd = (styledColumn) => ({
     type: exports.STYLED_COLUMN_ADD,

package/src/Redux/ActionsReducers/SystemStatusRedux.js

@@ -1,13 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemStatusReady = exports.SystemStatusSetMesage = exports.SYSTEM_STATUS_READY = exports.SYSTEM_STATUS_MESSAGE_SET = void 0;
-/**
- * @ReduxAction A System Status Message is set
- */
 exports.SYSTEM_STATUS_MESSAGE_SET = 'SYSTEM_STATUS_MESSAGE_SET';
-/**
- * @ReduxAction SystemStatus Module is ready
- */
 exports.SYSTEM_STATUS_READY = 'SYSTEM_STATUS_READY';
 const SystemStatusSetMesage = (systemStatusMessageInfo) => ({
     type: exports.SYSTEM_STATUS_MESSAGE_SET,

package/src/Redux/ActionsReducers/TeamSharingRedux.js

@@ -79,7 +79,6 @@ const TeamSharingReducer = (state = initialTeamSharingState, action) => {
         case exports.TEAMSHARING_SET: {
             const actionTyped = action;
             const sharedEntities = actionTyped.Entities;
-            // keep only the active entities which are still shared (some may have been removed by other users)
             const sharedEntityItemIds = sharedEntities.map((sharedEntity) => sharedEntity.Entity.Uuid);
             const activeSharedEntityMap = {};
             Object.keys(state.ActiveSharedEntityMap).forEach((activeObjectId) => {

package/src/Redux/ActionsReducers/ThemeRedux.js

@@ -3,33 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThemeReducer = exports.ThemeDelete = exports.ThemeAdd = exports.ThemeEdit = exports.ThemeReady = exports.ThemeSelect = exports.ThemeSetUserThemes = exports.ThemeSetSystemThemes = exports.THEME_DELETE = exports.THEME_ADD = exports.THEME_EDIT = exports.THEME_READY = exports.THEME_SELECT = exports.THEME_SET_USER_THEMES = exports.THEME_SET_SYSTEM_THEMES = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const ReduxConstants_1 = require("../../Utilities/Constants/ReduxConstants");
-/**
- * @ReduxAction System Themes have been set
- */
 exports.THEME_SET_SYSTEM_THEMES = 'THEME_SET_SYSTEM_THEMES';
-/**
- * @ReduxAction User Themes have been set
- */
 exports.THEME_SET_USER_THEMES = 'THEME_SET_USER_THEMES';
-/**
- * @ReduxAction A theme has been selected
- */
 exports.THEME_SELECT = 'THEME_SELECT';
-/**
- * @ReduxAction Theme Module is ready
- */
 exports.THEME_READY = 'THEME_READY';
-/**
- * @ReduxAction Theme Module is edited
- */
 exports.THEME_EDIT = 'THEME_EDIT';
-/**
- * @ReduxAction A new theme is added
- */
 exports.THEME_ADD = 'THEME_ADD';
-/**
- * @ReduxAction A theme is deleted
- */
 exports.THEME_DELETE = 'THEME_DELETE';
 const ThemeSetSystemThemes = (SystemThemes) => ({
     type: exports.THEME_SET_SYSTEM_THEMES,
@@ -87,14 +66,11 @@ const ThemeReducer = (state = initialState, action) => {
             });
         case exports.THEME_EDIT:
             let newThemes = null;
-            // find by UUID, or by name
             const themeToBeReplaced = action.theme;
             let replaceIndex = state.UserThemes.findIndex((theme) => themeToBeReplaced.Uuid === theme.Uuid);
-            // try by name
             if (replaceIndex === -1) {
                 replaceIndex = state.UserThemes.findIndex((theme) => themeToBeReplaced.Name === theme.Name);
             }
-            // fond one, either by name or by uuid
             if (replaceIndex !== -1) {
                 newThemes = [...state.UserThemes];
                 newThemes[replaceIndex] = themeToBeReplaced;
@@ -102,10 +78,8 @@ const ThemeReducer = (state = initialState, action) => {
             if (newThemes === null) {
                 return state;
             }
-            // if name changed, need to update the current name
             let currentTheme = state.CurrentTheme;
             if (currentTheme !== themeToBeReplaced.Name) {
-                // need to update the current theme if it name has changed
                 currentTheme = themeToBeReplaced.Name;
             }
             return Object.assign({}, state, {

package/src/Redux/ActionsReducers/ToolPanelRedux.js

@@ -1,33 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolPanelReducer = exports.ToolPanelReady = exports.ToolPanelSetModuleButtons = exports.ToolPanelCollapseToolPanel = exports.ToolPanelExpandToolPanel = exports.ToolPanelHideToolPanel = exports.ToolPanelShowToolPanel = exports.ToolPanelSetToolPanels = exports.TOOLPANEL_READY = exports.TOOLPANEL_SET_MODULE_BUTTONS = exports.TOOLPANEL_COLLAPSE_TOOLPANEL = exports.TOOLPANEL_EXPAND_TOOLPANEL = exports.TOOLPANEL_HIDE_TOOLPANEL = exports.TOOLPANEL_SHOW_TOOLPANEL = exports.TOOLPANEL_SET_TOOLPANELS = void 0;
-/**
- * @ReduxAction Tool Panels have been set in AdapTable ToolPanel Component
- */
 exports.TOOLPANEL_SET_TOOLPANELS = 'TOOLPANEL_SET_TOOLPANELS';
-/**
- * @ReduxAction A Tool Panel has been made visible
- */
 exports.TOOLPANEL_SHOW_TOOLPANEL = 'TOOLPANEL_SHOW_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been hidden
- */
 exports.TOOLPANEL_HIDE_TOOLPANEL = 'TOOLPANEL_HIDE_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been expanded
- */
 exports.TOOLPANEL_EXPAND_TOOLPANEL = 'TOOLPANEL_EXPAND_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been collapsed
- */
 exports.TOOLPANEL_COLLAPSE_TOOLPANEL = 'TOOLPANEL_COLLAPSE_TOOLPANEL';
-/**
- * @ReduxAction Module Buttons have set in AdapTable ToolPanel Component header
- */
 exports.TOOLPANEL_SET_MODULE_BUTTONS = 'TOOLPANEL_SET_MODULE_BUTTONS';
-/**
- * @ReduxAction AdapTable ToolPanel Component is ready
- */
 exports.TOOLPANEL_READY = 'TOOLPANEL_READY';
 const ToolPanelSetToolPanels = (toolPanels) => ({
     type: exports.TOOLPANEL_SET_TOOLPANELS,
@@ -65,7 +44,6 @@ const ToolPanelReady = (toolPanelState) => ({
 });
 exports.ToolPanelReady = ToolPanelReady;
 const initialState = {
-    // default ToolPanels are set in ToolPanelModule.updateOldConfig() because we have to evaluate the ToolPanelOptions (for CustomToolPanel)
     ToolPanels: undefined,
     ModuleButtons: ['SettingsPanel'],
 };

package/src/Redux/ActionsReducers/UserInterfaceRedux.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserInterfaceReducer = exports.UserInterfaceSetHideAdaptableUI = exports.USER_INTERFACE_SET_HIDE_ADAPTABLE_UI = void 0;
-/**
- * @ReduxAction Sets whether all AdapTable UI elements are hidden
- */
 exports.USER_INTERFACE_SET_HIDE_ADAPTABLE_UI = 'USER_INTERFACE_SET_HIDE_ADAPTABLE_UI';
 const UserInterfaceSetHideAdaptableUI = (hideAdaptableUI) => ({
     type: exports.USER_INTERFACE_SET_HIDE_ADAPTABLE_UI,

package/src/Redux/ActionsReducers/utils.js

@@ -3,12 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.changeIsSuspendInList = changeIsSuspendInList;
 exports.suspendAllInList = suspendAllInList;
 exports.unsuspendAllInList = unsuspendAllInList;
-/**
- * Updates IsSuspended in a list of adaptable objects
- *
- * @param abObjectToChange object to suspend
- * @param list list of ab objects
- */
 function changeIsSuspendInList(abObjectToChange, list, IsSuspended) {
     return list.map((abObject) => {
         if (!abObject.IsReadOnly && abObject?.Uuid === abObjectToChange?.Uuid) {

package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js

@@ -54,7 +54,6 @@ class AdaptableReduxLocalStorageEngine {
     }
     load(adaptableInstance, initialState = this.initialState) {
         return (this.loadState || loadState)((0, buildAdaptableStateFunctionConfig_1.buildAdaptableStateFunctionConfig)(adaptableInstance)).then((parsedJsonState) => {
-            // we need to merge the Initial Adaptable State
             return Promise.resolve(initialState)
                 .then((parsedInitialState) => {
                 return (0, AdaptableReduxMerger_1.MergeStateFunction)(parsedInitialState, parsedJsonState);

package/src/Redux/Store/AdaptableReduxMerger.js

@@ -13,20 +13,11 @@ const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpe
 function customizer(objValue, srcValue) {
     if ((0, ArrayExtensions_1.isArray)(objValue)) {
         if (!Array.isArray(srcValue)) {
-            // TODO AFL: clarify if this is still relevant, after the state & options refactoring
-            /**
-             * the new value might be a function: eg: UserInterface.ContextMenuItems defaults to an array
-             * in the redux state, while the user might provide a function
-             * so in this case, make the user provided value win
-             */
             return srcValue;
         }
         const length = srcValue ? srcValue.length : null;
         const result = (0, ObjectExtensions_1.mergeWith)(objValue, srcValue, customizer);
         if (length != null) {
-            // when merging arrays, lodash result has the length of the
-            // longest array, but we don't want that to happen
-            // so we restrict to the current length
             result.length = length;
         }
         return result;
@@ -35,7 +26,6 @@ function customizer(objValue, srcValue) {
 function AddStateSource(stateObject = {}, source) {
     const traverseStateObject = (object) => {
         Object.values(object).forEach((value) => {
-            // add a Source only to AdaptableObjects which do NOT already have a source defined
             if (AdaptableHelper_1.default.isAdaptableObject(value) && value.Source == null) {
                 value.Source = source;
             }
@@ -56,8 +46,6 @@ function ProcessKeepUserDefinedRevision(configState, currentUserState) {
                     return AdaptableHelper_1.default.isAdaptableObject(item) && item.Source !== 'InitialState';
                 });
                 configObject[key] = configValue.concat(userDefinedItems);
-                // we probably don't need to call traverseStateObject on the array as well,
-                // so we do the traversing on the else branch only
             }
             else {
                 if (configValue !== null &&
@@ -75,30 +63,23 @@ function deepClone(obj) {
     return JSON.parse(JSON.stringify(obj));
 }
 function MergeStateFunction(oldState, newState) {
-    // return MergeState(oldState, newState);
     if (newState === '') {
         newState = {};
     }
-    // add source 'InitialState' only to initial state objects
     const initialState = AddStateSource(oldState, 'InitialState');
-    // source 'User' will be added to all other objects, after the merge (see bottom of this function)
     let state = newState;
     if (!state || typeof state !== 'object') {
-        // in case loadState returns something different than an empty object
         AdaptableLogger_1.AdaptableLogger.consoleWarnBase('State is something different than expected; expected an object, but received: ', state);
         state = {};
     }
-    // any Module in config that doesn't exist in state will be added
     for (const initialStateModuleName in initialState) {
         if (!state[initialStateModuleName]) {
             const { Revision, ...moduleState } = initialState[initialStateModuleName];
             state[initialStateModuleName] = moduleState;
         }
     }
-    // any Module in state that has an older revision than the config will be replaced
     for (const stateModuleName in state) {
         if (initialState[stateModuleName] != undefined) {
-            // explicitly use double equals, as we want to avoid null as well
             const stateRevision = state[stateModuleName].Revision ?? 0;
             const initialStateRevision = initialState[stateModuleName].Revision ?? 0;
             const stateRevisionKey = typeof stateRevision === 'object' ? stateRevision.Key : stateRevision;
@@ -114,11 +95,9 @@ function MergeStateFunction(oldState, newState) {
             }
         }
     }
-    // add 'User' source to all state objects which do NOT have 'InitialState'
     const finalState = AddStateSource(state, 'User');
     return finalState;
 }
-// main merge function
 function MergeState(oldState, newState) {
     const result = Object.assign({}, oldState);
     for (const key in newState) {
@@ -126,14 +105,12 @@ function MergeState(oldState, newState) {
             continue;
         }
         const value = newState[key];
-        // Assign if we don't need to merge at all
         if (!result.hasOwnProperty(key)) {
             result[key] = (0, ObjectExtensions_1.isObject)(value) && !Array.isArray(value) ? (0, ObjectExtensions_1.merge)({}, value) : value;
             continue;
         }
         const oldValue = result[key];
         if ((0, ObjectExtensions_1.isObject)(value) && !Array.isArray(value)) {
-            // use both lodash functions so that we can merge from State onto Initial Adaptable State where it exists but from the former where it doesnt.
             result[key] = (0, ObjectExtensions_1.mergeWith)({}, oldValue, value, customizer);
         }
         else {
@@ -149,8 +126,6 @@ const mergeReducer = (rootReducer, LOAD_STATE_TYPE) => {
         if (action.type === LOAD_STATE_TYPE) {
             initialState = initialState ?? state;
             state = MergeState(initialState, action.State);
-            // put this new state on the action, since the root reducer further copies
-            // keys from action.State to the new state
             action.State = state;
         }
         return rootReducer(state, action);