@adaptabletools/adaptable 23.0.4 → 23.0.5-canary.1

package/src/Redux/ActionsReducers/ThemeRedux.js

@@ -1,32 +1,11 @@
 import { EMPTY_ARRAY } from '../../Utilities/Constants/GeneralConstants';
 import { THEME_DEFAULT_CURRENT_THEME, SYSTEM_THEMES, } from '../../Utilities/Constants/ReduxConstants';
-/**
- * @ReduxAction System Themes have been set
- */
 export const THEME_SET_SYSTEM_THEMES = 'THEME_SET_SYSTEM_THEMES';
-/**
- * @ReduxAction User Themes have been set
- */
 export const THEME_SET_USER_THEMES = 'THEME_SET_USER_THEMES';
-/**
- * @ReduxAction A theme has been selected
- */
 export const THEME_SELECT = 'THEME_SELECT';
-/**
- * @ReduxAction Theme Module is ready
- */
 export const THEME_READY = 'THEME_READY';
-/**
- * @ReduxAction Theme Module is edited
- */
 export const THEME_EDIT = 'THEME_EDIT';
-/**
- * @ReduxAction A new theme is added
- */
 export const THEME_ADD = 'THEME_ADD';
-/**
- * @ReduxAction A theme is deleted
- */
 export const THEME_DELETE = 'THEME_DELETE';
 export const ThemeSetSystemThemes = (SystemThemes) => ({
     type: THEME_SET_SYSTEM_THEMES,
@@ -77,14 +56,11 @@ export const ThemeReducer = (state = initialState, action) => {
             });
         case 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;
@@ -92,10 +68,8 @@ export 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,30 +1,9 @@
-/**
- * @ReduxAction Tool Panels have been set in AdapTable ToolPanel Component
- */
 export const TOOLPANEL_SET_TOOLPANELS = 'TOOLPANEL_SET_TOOLPANELS';
-/**
- * @ReduxAction A Tool Panel has been made visible
- */
 export const TOOLPANEL_SHOW_TOOLPANEL = 'TOOLPANEL_SHOW_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been hidden
- */
 export const TOOLPANEL_HIDE_TOOLPANEL = 'TOOLPANEL_HIDE_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been expanded
- */
 export const TOOLPANEL_EXPAND_TOOLPANEL = 'TOOLPANEL_EXPAND_TOOLPANEL';
-/**
- * @ReduxAction A Tool Panel has been collapsed
- */
 export const TOOLPANEL_COLLAPSE_TOOLPANEL = 'TOOLPANEL_COLLAPSE_TOOLPANEL';
-/**
- * @ReduxAction Module Buttons have set in AdapTable ToolPanel Component header
- */
 export const TOOLPANEL_SET_MODULE_BUTTONS = 'TOOLPANEL_SET_MODULE_BUTTONS';
-/**
- * @ReduxAction AdapTable ToolPanel Component is ready
- */
 export const TOOLPANEL_READY = 'TOOLPANEL_READY';
 export const ToolPanelSetToolPanels = (toolPanels) => ({
     type: TOOLPANEL_SET_TOOLPANELS,
@@ -55,7 +34,6 @@ export const ToolPanelReady = (toolPanelState) => ({
     toolPanelState,
 });
 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,6 +1,3 @@
-/**
- * @ReduxAction Sets whether all AdapTable UI elements are hidden
- */
 export const USER_INTERFACE_SET_HIDE_ADAPTABLE_UI = 'USER_INTERFACE_SET_HIDE_ADAPTABLE_UI';
 export const UserInterfaceSetHideAdaptableUI = (hideAdaptableUI) => ({
     type: USER_INTERFACE_SET_HIDE_ADAPTABLE_UI,

package/src/Redux/ActionsReducers/utils.js

@@ -1,9 +1,3 @@
-/**
- * Updates IsSuspended in a list of adaptable objects
- *
- * @param abObjectToChange object to suspend
- * @param list list of ab objects
- */
 export function changeIsSuspendInList(abObjectToChange, list, IsSuspended) {
     return list.map((abObject) => {
         if (!abObject.IsReadOnly && abObject?.Uuid === abObjectToChange?.Uuid) {

package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js

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

package/src/Redux/Store/AdaptableReduxMerger.js

@@ -5,20 +5,11 @@ import AdaptableHelper from '../../Utilities/Helpers/AdaptableHelper';
 function customizer(objValue, srcValue) {
     if (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 = 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;
@@ -27,7 +18,6 @@ function customizer(objValue, srcValue) {
 export 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.isAdaptableObject(value) && value.Source == null) {
                 value.Source = source;
             }
@@ -48,8 +38,6 @@ export function ProcessKeepUserDefinedRevision(configState, currentUserState) {
                     return AdaptableHelper.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 &&
@@ -67,30 +55,23 @@ function deepClone(obj) {
     return JSON.parse(JSON.stringify(obj));
 }
 export 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.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;
@@ -106,11 +87,9 @@ export 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
 export function MergeState(oldState, newState) {
     const result = Object.assign({}, oldState);
     for (const key in newState) {
@@ -118,14 +97,12 @@ export 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] = isObject(value) && !Array.isArray(value) ? merge({}, value) : value;
             continue;
         }
         const oldValue = result[key];
         if (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] = mergeWith({}, oldValue, value, customizer);
         }
         else {
@@ -141,8 +118,6 @@ export 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);