@adaptabletools/adaptable 18.1.14 → 18.1.15-canary.0

package/src/Utilities/Services/ChartingService.js

@@ -1,4 +1,3 @@
-import { Events } from '@ag-grid-community/core';
 import * as SystemRedux from '../../Redux/ActionsReducers/SystemRedux';
 import ObjectFactory from '../ObjectFactory';
 export class ChartingService {
@@ -10,7 +9,7 @@ export class ChartingService {
         const currentChartModel = models.find((model) => model.chartId === params.chartId);
         const currentChartDefinition = allChartDefinitions.find((chartDefinition) => chartDefinition.Model.chartId === params.chartId);
         switch (eventType) {
-            case Events.EVENT_CHART_CREATED:
+            case 'chartCreated':
                 const createParams = params;
                 if (allChartDefinitions.some((chartDefinition) => chartDefinition.Model.chartId === createParams.chartId)) {
                     // chart already exists
@@ -20,8 +19,8 @@ export class ChartingService {
                     this.saveNewChart(chartModel);
                 }
                 break;
-            case Events.EVENT_CHART_OPTIONS_CHANGED:
-            case Events.EVENT_CHART_RANGE_SELECTION_CHANGED:
+            case 'chartOptionsChanged':
+            case 'chartRangeSelectionChanged':
                 if (!currentChartDefinition) {
                     // editing a non-saved chart
                     break;
@@ -42,18 +41,13 @@ export class ChartingService {
      */
     emitAdaptableChartDefinitonChange() {
         const chartingOpenState = this.api.chartingApi.getChartingOpenState();
-        const chartChangedInfo = {
-            chartingOpenState: chartingOpenState,
-            adaptableApi: this.api,
-            userName: this.api.optionsApi.getUserName(),
-            adaptableId: this.api.optionsApi.getAdaptableId(),
-        };
+        const chartChangedInfo = Object.assign({ chartingOpenState: chartingOpenState }, this.api.internalApi.buildBaseContext());
         this.api.eventApi.emit('ChartChanged', chartChangedInfo);
     }
     saveNewChart(chartModel) {
         var _a, _b;
         const chartingOptions = (_a = this.api.optionsApi.getChartingOptions()) !== null && _a !== void 0 ? _a : {};
-        const saveStragegy = (_b = chartingOptions.saveStrategy) !== null && _b !== void 0 ? _b : 'manual';
+        const saveStragegy = (_b = chartingOptions.saveChartBehaviour) !== null && _b !== void 0 ? _b : 'manual';
         if (saveStragegy === 'none') {
             return;
         }

package/src/Utilities/Services/ModuleService.js

@@ -7,25 +7,25 @@ export class ModuleService {
         this.adaptableApi = adaptableApi;
     }
     createModuleMenus() {
-        const settingsPanelMenuItems = [];
-        const buttonMenuItems = [];
+        const settingsPanelItems = [];
+        const adaptableMenuItems = [];
         this.getModuleCollection().forEach((module) => {
             const settingsPanelMenuItem = module.createModuleMenuItem('ModuleMenu');
             if (Helper.objectExists(settingsPanelMenuItem)) {
-                if (settingsPanelMenuItems.findIndex((m) => m.module == settingsPanelMenuItem.module) == -1) {
-                    settingsPanelMenuItems.push(settingsPanelMenuItem);
+                if (settingsPanelItems.findIndex((m) => m.module == settingsPanelMenuItem.module) == -1) {
+                    settingsPanelItems.push(settingsPanelMenuItem);
                 }
             }
-            const buttonMenuItem = module.createModuleMenuItem('ModuleButton');
-            if (Helper.objectExists(buttonMenuItem)) {
-                if (buttonMenuItems.findIndex((m) => m.module == buttonMenuItem.module) == -1) {
-                    buttonMenuItems.push(buttonMenuItem);
+            const adaptableMenuItem = module.createModuleMenuItem('ModuleButton');
+            if (Helper.objectExists(adaptableMenuItem)) {
+                if (adaptableMenuItems.findIndex((m) => m.module == adaptableMenuItem.module) == -1) {
+                    adaptableMenuItems.push(adaptableMenuItem);
                 }
             }
         });
         // store the main menu as we will re-use (and it never changes)
-        this.adaptableApi.internalApi.setSettingPanelModuleMenuItems(settingsPanelMenuItems);
-        this.adaptableApi.internalApi.setModuleButtonMenuItems(buttonMenuItems);
+        this.adaptableApi.internalApi.setSettingsPanelItems(settingsPanelItems);
+        this.adaptableApi.internalApi.setMenuModuleItems(adaptableMenuItems);
     }
     isModuleAvailable(adaptableModule) {
         let module = this.getModuleCollection().get(adaptableModule);
@@ -87,52 +87,62 @@ export class ModuleService {
                 return learnUrl + 'handbook-calculated-column';
             case 'CellSummary':
                 return learnUrl + 'handbook-summarising';
+            case 'Charting':
+                return learnUrl + 'handbook-charts';
+            case 'ColumnFilter':
+                return learnUrl + 'handbook-column-filter';
+            case 'ColumnInfo':
+                return learnUrl + 'dev-guide-tutorial-grid-column-info';
+            case 'Comment':
+                return learnUrl + 'handbook-comments';
             case 'CustomSort':
-                return learnUrl + 'handbook-sorting';
+                return learnUrl + 'handbook-sorting-custom';
             case 'Dashboard':
                 return learnUrl + 'ui-dashboard';
-            case 'DataSet':
-                return learnUrl + 'handbook-data-sets';
-            case 'DataImport':
-                return learnUrl + 'handbook-importing';
             case 'DataChangeHistory':
                 return learnUrl + 'handbook-monitoring-data-change-history';
+            case 'DataImport':
+                return learnUrl + 'handbook-importing';
+            case 'DataSet':
+                return learnUrl + 'handbook-data-sets';
             case 'Export':
                 return learnUrl + 'handbook-exporting';
-            case 'ColumnFilter':
-                return learnUrl + 'handbook-column-filter';
-            case 'Comment':
-                return learnUrl + 'handbook-comments';
-            case 'GridFilter':
-                return learnUrl + 'handbook-grid-filter';
+            case 'Fdc3':
+                return learnUrl + 'handbook-fdc3';
             case 'FlashingCell':
                 return learnUrl + 'handbook-flashing-cell';
             case 'FormatColumn':
                 return learnUrl + 'handbook-column-formatting';
             case 'FreeTextColumn':
                 return learnUrl + 'handbook-freetext-column';
+            case 'GridFilter':
+                return learnUrl + 'handbook-grid-filter';
             case 'GridInfo':
-                return learnUrl + 'handbook-monitoring-grid-info';
+                return learnUrl + 'dev-guide-tutorial-grid-column-info';
             case 'Layout':
                 return learnUrl + 'handbook-layouts';
+            case 'NamedQuery':
+                return learnUrl + 'handbook-named-queries';
             case 'Note':
                 return learnUrl + 'handbook-notes';
             case 'PlusMinus':
                 return learnUrl + 'handbook-editing-plus-minus';
-            case 'NamedQuery':
-                return learnUrl + 'handbook-named-queries';
             case 'QuickSearch':
                 return learnUrl + 'handbook-quick-search';
             case 'Schedule':
                 return learnUrl + 'handbook-scheduling';
+            case 'SettingsPanel':
+                return learnUrl + 'ui-settings-panel';
             case 'Shortcut':
                 return learnUrl + 'handbook-editing-shortcut';
             case 'SmartEdit':
                 return learnUrl + 'handbook-editing-smart-edit';
             case 'StateManagement':
-                return learnUrl + 'dev-guide-adaptable-state';
+                return learnUrl + 'dev-guide-adaptable-state-management';
             case 'StatusBar':
                 return learnUrl + 'ui-status-bar';
+            case 'StyledColumn':
+                return learnUrl + 'handbook-styled-column-overview';
             case 'SystemStatus':
                 return learnUrl + 'handbook-system-status-message';
             case 'TeamSharing':
@@ -145,12 +155,6 @@ export class ModuleService {
                 return learnUrl + 'integrations-ipushpull';
             case 'OpenFin':
                 return learnUrl + 'integrations-openfin';
-            case 'StyledColumn':
-                return learnUrl + 'handbook-styled-column-overview';
-            case 'Charting':
-                return learnUrl + 'handbook-charts';
-            case 'DataImport':
-                return learnUrl + 'handbook-data-import';
             default:
                 return 'good';
         }

package/src/Utilities/Services/RowEditService.js

@@ -23,12 +23,7 @@ export class RowEditService {
             const setPrimaryKeyValueFunction = adaptableApi.internalApi.getAdaptableInstance().adaptableOptions.actionRowOptions
                 .setPrimaryKeyValue;
             const newRowData = typeof setPrimaryKeyValueFunction === 'function'
-                ? setPrimaryKeyValueFunction({
-                    rowData: formData,
-                    adaptableApi,
-                    userName: this.adaptableApi.optionsApi.getUserName(),
-                    adaptableId: this.adaptableApi.optionsApi.getAdaptableId(),
-                })
+                ? setPrimaryKeyValueFunction(Object.assign({ rowData: formData }, adaptableApi.internalApi.buildBaseContext()))
                 : Object.assign({}, formData);
             const config = {
                 addIndex: 0,

package/src/Utilities/Services/RowSummaryService.js

@@ -96,7 +96,7 @@ export class RowSummaryService {
         const rowSummaries = (_a = this.api.layoutApi.getCurrentLayout().RowSummaries) !== null && _a !== void 0 ? _a : [];
         const rowSummariesResults = rowSummaries
             .filter((rowSummary) => !rowSummary.IsSuspended)
-            .map((rowSummary) => {
+            .map((rowSummary, index) => {
             const { ColumnsMap, Position, 
             // it defaults to true
             IncludeOnlyFilteredRows = true, } = rowSummary;
@@ -159,7 +159,7 @@ export class RowSummaryService {
                     acc = this.api.internalApi.setValueUsingField(acc, fieldName, value);
                     return acc;
                 }, {
-                    [ROW_SUMMARY_ROW_ID]: true,
+                    [ROW_SUMMARY_ROW_ID]: `row-summary-${index}`,
                 }),
             };
         });

package/src/Utilities/Services/ValidationService.js

@@ -70,25 +70,11 @@ export class ValidationService {
     IsAlertDefinitionTriggered(alertDefinition, dataChangedEvent) {
         var _a;
         const displayValue = this.adaptableApi.gridApi.getDisplayValueFromRowNode(dataChangedEvent.rowNode, dataChangedEvent.column.columnId);
-        const predicateDefHandlerContext = {
-            value: dataChangedEvent.newValue,
-            oldValue: dataChangedEvent.oldValue,
-            displayValue,
-            node: dataChangedEvent.rowNode,
-            column: dataChangedEvent.column,
-            adaptableApi: this.adaptableApi,
-            userName: this.adaptableApi.optionsApi.getUserName(),
-            adaptableId: this.adaptableApi.optionsApi.getAdaptableId(),
-        };
+        const predicateDefHandlerContext = Object.assign({ value: dataChangedEvent.newValue, oldValue: dataChangedEvent.oldValue, displayValue, node: dataChangedEvent.rowNode, column: dataChangedEvent.column }, this.adaptableApi.internalApi.buildBaseContext());
         return this.adaptableApi.predicateApi.handlePredicates((_a = alertDefinition.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, predicateDefHandlerContext, false);
     }
     performServerValidation(cellDataChangedInfo, config) {
-        const serverValidationContext = {
-            cellDataChangedInfo: cellDataChangedInfo,
-            adaptableApi: this.adaptableApi,
-            userName: this.adaptableApi.optionsApi.getUserName(),
-            adaptableId: this.adaptableApi.optionsApi.getAdaptableId(),
-        };
+        const serverValidationContext = Object.assign({ cellDataChangedInfo: cellDataChangedInfo }, this.adaptableApi.internalApi.buildBaseContext());
         return () => {
             this.adaptableApi.optionsApi
                 .getEditOptions()

package/src/View/Alert/AlertEmptyView.js

@@ -2,8 +2,7 @@ import * as React from 'react';
 import { useAdaptable } from '../AdaptableContext';
 export const AlertEmptyView = (props) => {
     const adaptable = useAdaptable();
-    const accessLevel = adaptable.api.internalApi
-        .getEntitlementService()
+    const accessLevel = adaptable.api.entitlementApi
         .getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
     const text = accessLevel == 'ReadOnly'
         ? 'You have no Alert Definitions.'

package/src/View/Charting/ChartingStatusBarPopover.js

@@ -5,8 +5,7 @@ import { useChartingElements } from './useChartingElements';
 import { Box, Flex } from 'rebass';
 export const ChartingStatusBarPopover = (props) => {
     const adaptable = useAdaptable();
-    const accessLevel = adaptable.api.internalApi
-        .getEntitlementService()
+    const accessLevel = adaptable.api.entitlementApi
         .getEntitlementAccessLevelForModule(ModuleConstants.ChartingModuleId);
     const { chartSelector, containerSelector, chartButton, deleteButton, editButton } = useChartingElements({
         elementType: 'Statusbar',

package/src/View/Charting/useChartingElements.js

@@ -24,7 +24,7 @@ export const useChartingElements = ({ elementType, accessLevel, size = 'normal',
     });
     const selectedChart = allChartDefinitions.find((chart) => chart.Uuid === selectedChartId);
     const isAgChart = isAgChartDefinition(selectedChart);
-    const chartAccessLevel = AdaptableHelper.getAppropriateAccessLevel(selectedChart, accessLevel);
+    const chartAccessLevel = AdaptableHelper.getAccessLevelForObject(selectedChart, accessLevel);
     const [selectedContainer, setSelectedContainer] = React.useState(null);
     // Need to always call as they the rule for hooks
     const { isOpen: isAgChartOpen, showChart: showAgChart, closeChart: hideAgChart, } = useAgChartState(isAgChart ? selectedChart : undefined);

package/src/View/Components/AdaptableObjectList/AdaptableObjectCompactList.js

@@ -13,9 +13,7 @@ export const AdaptableObjectCompactListItem = (props) => {
     const objectView = props.module.toViewCompact(props.abObject);
     const viewOptions = (_b = (_a = props.module) === null || _a === void 0 ? void 0 : _a.getViewProperties) === null || _b === void 0 ? void 0 : _b.call(_a);
     const deleteAction = (_c = viewOptions === null || viewOptions === void 0 ? void 0 : viewOptions.getCompactDeleteAction) === null || _c === void 0 ? void 0 : _c.call(viewOptions, props.abObject);
-    const moduleAccessLevel = adaptable.api.internalApi
-        .getEntitlementService()
-        .getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
+    const moduleAccessLevel = adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
     const suspendAction = (_d = viewOptions === null || viewOptions === void 0 ? void 0 : viewOptions.getCompactSuspendAction) === null || _d === void 0 ? void 0 : _d.call(viewOptions, props.abObject);
     const unSuspendAction = (_e = viewOptions === null || viewOptions === void 0 ? void 0 : viewOptions.getCompactUnSuspendAction) === null || _e === void 0 ? void 0 : _e.call(viewOptions, props.abObject);
     const isSuspended = props.abObject.IsSuspended;
@@ -60,9 +58,7 @@ export const AdaptableObjectCompactList = (props) => {
     const suspendAllAction = (_d = viewProperties === null || viewProperties === void 0 ? void 0 : viewProperties.getSuspendAllAction) === null || _d === void 0 ? void 0 : _d.call(viewProperties);
     const unSuspendAllAction = (_e = viewProperties === null || viewProperties === void 0 ? void 0 : viewProperties.getUnSuspendAllAction) === null || _e === void 0 ? void 0 : _e.call(viewProperties);
     const dispatch = useDispatch();
-    const accessLevel = adaptable.api.internalApi
-        .getEntitlementService()
-        .getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
+    const accessLevel = adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
     const isAtLeastOneAbObjectActive = props.abObjects.some((abObject) => {
         return !abObject.IsSuspended;
     });

package/src/View/Components/AdaptableObjectList/AdaptableObjectList.js

@@ -88,10 +88,8 @@ export const AdaptableObjectListItem = (props) => {
         adaptable.api.teamSharingApi.isTeamSharingAvailable() &&
         adaptable.api.teamSharingApi.hasTeamSharingFullRights();
     const entityType = props.module.moduleInfo.FriendlyName;
-    const moduleAccessLevel = adaptable.api.internalApi
-        .getEntitlementService()
-        .getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
-    const accessLevel = AdaptableHelper.getAppropriateAccessLevel(props.data.abObject, moduleAccessLevel);
+    const moduleAccessLevel = adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(props.module.moduleInfo.ModuleName);
+    const accessLevel = AdaptableHelper.getAccessLevelForObject(props.data.abObject, moduleAccessLevel);
     const itemClassName = join(props.data.className, ITEM_BASE_CLASS_NAME, props.data.abObject.IsSuspended &&
         `${ITEM_BASE_CLASS_NAME}--is-suspended`);
     const handleCloseWizard = React.useCallback(() => {

package/src/View/Components/FilterForm/QuickFilterForm.js

@@ -57,23 +57,13 @@ class QuickFilterFormComponent extends React.Component {
         let hideQuickFilterDropdownFunction = this.props.api.optionsApi.getColumnFilterOptions().quickFilterOptions
             .hideQuickFilterDropdown;
         if (hideQuickFilterDropdownFunction) {
-            const columnFilterContext = {
-                column: this.props.currentColumn,
-                adaptableApi: this.props.api,
-                userName: this.props.api.optionsApi.getUserName(),
-                adaptableId: this.props.api.optionsApi.getAdaptableId(),
-            };
+            const columnFilterContext = Object.assign({ column: this.props.currentColumn }, this.props.api.internalApi.buildBaseContext());
             showQuickFilterDropdown = !hideQuickFilterDropdownFunction(columnFilterContext);
         }
         let showQuickFilterInput = true;
         let hideQuickFilterInputFunction = this.props.api.optionsApi.getColumnFilterOptions().quickFilterOptions.hideQuickFilterInput;
         if (hideQuickFilterInputFunction) {
-            const columnFilterContext = {
-                column: this.props.currentColumn,
-                adaptableApi: this.props.api,
-                userName: this.props.api.optionsApi.getUserName(),
-                adaptableId: this.props.api.optionsApi.getAdaptableId(),
-            };
+            const columnFilterContext = Object.assign({ column: this.props.currentColumn }, this.props.api.internalApi.buildBaseContext());
             showQuickFilterInput = !hideQuickFilterInputFunction(columnFilterContext);
         }
         return (React.createElement(React.Fragment, null,

package/src/View/Components/ModuleValueSelector/index.js

@@ -3,7 +3,7 @@ import * as React from 'react';
 import { ValueSelector } from '../ValueSelector';
 import { useAdaptable } from '../../AdaptableContext';
 import { useMemo, useCallback } from 'react';
-import { sortWithOrderArray } from '../../../Utilities/sortWithOrder';
+import ArrayExtensions from '../../../Utilities/Extensions/ArrayExtensions';
 export const ModuleValueSelector = (props) => {
     const { options, value, onChange, selectionBoxPosition = 'top' } = props, valueSelectorProps = __rest(props, ["options", "value", "onChange", "selectionBoxPosition"]);
     const { api } = useAdaptable();
@@ -25,7 +25,7 @@ export const ModuleValueSelector = (props) => {
         return labelMap;
     }, [options]);
     const sortedOptions = useMemo(() => {
-        return sortWithOrderArray(options, value, { sortUnorderedItems: true });
+        return ArrayExtensions.sortArrayWithOrder(options, value, { sortUnorderedItems: true });
     }, [allowReorder, options, value]);
     return (React.createElement(ValueSelector, Object.assign({}, valueSelectorProps, { options: sortedOptions, value: value, onChange: onChange, allowReorder: allowReorder, toIdentifier: (module) => module, toLabel: (module) => moduleLabelMap.get(module), selectionBoxPosition: selectionBoxPosition, isOptionDisabled: props.isOptionDisabled, disabled: props.disabled })));
 };

package/src/View/Components/Popups/AdaptablePopup/AdaptablePopup.js

@@ -6,7 +6,6 @@ import join from '../../../../components/utils/join';
 import { Navigation } from './Navigation';
 import PopupContext from './PopupContext';
 import { AdaptablePopupBody } from './AdaptablePopupBody';
-import { STANDALONE_MODULE_POPUPS } from '../../../../Utilities/Defaults/DefaultSettingsPanel';
 import { useAdaptable } from '../../../AdaptableContext';
 import { CustomSettingsPanelView } from './CustomSettingsPanelView';
 import { useMenuItems } from './useMenuItems';
@@ -50,13 +49,11 @@ export const AdaptablePopup = (props) => {
     else {
         const module = props.api.internalApi.getModuleService().getModuleById(componentModule);
         const moduleInfo = module === null || module === void 0 ? void 0 : module.moduleInfo;
-        accessLevel = props.api.internalApi
-            .getEntitlementService()
-            .getEntitlementAccessLevelForModule(componentModule);
+        accessLevel = props.api.entitlementApi.getEntitlementAccessLevelForModule(componentModule);
         friendlyName = moduleInfo.FriendlyName;
         isStandalone =
             moduleInfo &&
-                (STANDALONE_MODULE_POPUPS.includes(moduleInfo === null || moduleInfo === void 0 ? void 0 : moduleInfo.ModuleName) ||
+                (GeneralConstants.STANDALONE_MODULE_POPUPS.includes(moduleInfo === null || moduleInfo === void 0 ? void 0 : moduleInfo.ModuleName) ||
                     (props.componentName && props.componentName !== (moduleInfo === null || moduleInfo === void 0 ? void 0 : moduleInfo.Popup)));
         activeItem = moduleInfo.ModuleName;
         moduleViewContent = (React.createElement(AdaptablePopupBody, { api: props.api, module: module, componentName: props.componentName, moduleParams: props.moduleParams, onClearParams: props.onClearParams, onHide: props.onHide }));

package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupBody.js

@@ -6,9 +6,7 @@ export const AdaptablePopupBody = (props) => {
     var _a;
     const modalContainer = UIHelper.getModalContainer(props.api.optionsApi.getAdaptableOptions(), document);
     const moduleName = props.module.moduleInfo.ModuleName;
-    const accessLevel = props.api.internalApi
-        .getEntitlementService()
-        .getEntitlementAccessLevelForModule(moduleName);
+    const accessLevel = props.api.entitlementApi.getEntitlementAccessLevelForModule(moduleName);
     const moduleInfo = props.api.internalApi.getModuleService().getModuleInfoByModule(moduleName);
     const moduleProps = {
         popupParams: props.moduleParams,

package/src/View/Components/Popups/AdaptablePopup/useMenuItems.js

@@ -1,8 +1,9 @@
 import * as React from 'react';
 import { useSelector } from 'react-redux';
-import { STANDALONE_MODULE_POPUPS, DEFAULT_SETTINGS_PANEL_NAVIGATION_ITEMS, } from '../../../../Utilities/Defaults/DefaultSettingsPanel';
+import { DEFAULT_SETTINGS_PANEL_NAVIGATION_ITEMS } from '../../../../Utilities/Defaults/DefaultSettingsPanel';
 import { useAdaptable } from '../../../AdaptableContext';
 import * as PopupRedux from '../../../../Redux/ActionsReducers/PopupRedux';
+import { STANDALONE_MODULE_POPUPS } from '../../../../Utilities/Constants/GeneralConstants';
 export const useMenuItems = () => {
     const adaptable = useAdaptable();
     const settingsPanelOptions = adaptable.adaptableOptions.settingsPanelOptions;

package/src/View/Components/Popups/AdaptablePopupAlert.js

@@ -24,13 +24,7 @@ export const AdaptablePopupAlert = (props) => {
     }, []);
     const [formData, setFormData] = useState({});
     const context = React.useMemo(() => {
-        return {
-            alert: props.adaptableAlert,
-            adaptableApi: api,
-            formData: formData,
-            userName: api.optionsApi.getUserName(),
-            adaptableId: api.optionsApi.getAdaptableId(),
-        };
+        return Object.assign(Object.assign({ alert: props.adaptableAlert }, api.internalApi.buildBaseContext()), { formData: formData });
     }, [JSON.stringify(formData), props.adaptableAlert]);
     const adaptableForm = React.useMemo(() => {
         if (api.isDestroyed()) {

package/src/View/Components/ToolPanel/AdaptableToolPanel.js

@@ -21,27 +21,26 @@ const preventDefault = (e) => e.preventDefault();
 const AdaptableToolPanelComponent = (props) => {
     var _a;
     const toolPanelsGlyph = React.createElement(Icon, { name: 'align-justify' });
-    const entitlementService = props.api.internalApi.getEntitlementService();
     const moduleService = props.api.internalApi.getModuleService();
     const adaptableOptions = props.api.optionsApi.getAdaptableOptions();
     const toolPanelOptions = adaptableOptions.toolPanelOptions;
     const settingsPanelOptions = adaptableOptions.settingsPanelOptions;
-    if (entitlementService.isModuleHiddenEntitlement('ToolPanel')) {
+    if (props.api.entitlementApi.isModuleHiddenEntitlement('ToolPanel')) {
         // do NOT show any toolPanel content if the required entitlements are missing
         return (React.createElement(HelpBlock, { mt: 2, mb: 2, p: 2, style: { fontSize: 'var(--ab-font-size-3)' } }, "Not enough rights"));
     }
     const availableModuleItems = props.MainMenuItems.filter((menuItem) => menuItem.isVisible);
     const availableModules = availableModuleItems.map((menuItem) => menuItem.module);
     // 'Dashboard' is a special case because it's not available in the dashboard menu items, s we have to add it manually
-    if (!entitlementService.isModuleHiddenEntitlement('Dashboard')) {
+    if (!props.api.entitlementApi.isModuleHiddenEntitlement('Dashboard')) {
         availableModules.push('Dashboard');
     }
     if (props.api.pluginsApi.getipushpullPluginApi() &&
-        !entitlementService.isModuleHiddenEntitlement('IPushPull')) {
+        !props.api.entitlementApi.isModuleHiddenEntitlement('IPushPull')) {
         availableModules.push('IPushPull');
     }
     if (props.api.pluginsApi.getOpenFinPluginApi() &&
-        !entitlementService.isModuleHiddenEntitlement('OpenFin')) {
+        !props.api.entitlementApi.isModuleHiddenEntitlement('OpenFin')) {
         availableModules.push('OpenFin');
     }
     const availableModuleToolPanels = ALL_TOOL_PANELS.filter((moduleToolPanel) => ArrayExtensions.ContainsItem(availableModules, moduleToolPanel));
@@ -125,7 +124,7 @@ const AdaptableToolPanelComponent = (props) => {
         const toolPanelButtons = [];
         let moduleButtons = props.ModuleButtons;
         const shouldAddSettingsPanel = settingsPanelOptions.alwaysShowInToolPanel &&
-            !props.api.internalApi.getEntitlementService().isModuleHiddenEntitlement('SettingsPanel');
+            !props.api.entitlementApi.isModuleHiddenEntitlement('SettingsPanel');
         if (shouldAddSettingsPanel && !moduleButtons.includes('SettingsPanel')) {
             moduleButtons = ['SettingsPanel', ...moduleButtons];
         }
@@ -143,12 +142,7 @@ const AdaptableToolPanelComponent = (props) => {
         return props.api.toolPanelApi.getCustomToolPanelButtons().map((button) => {
             // TODO: variants of this mapping are present in several places (just search for api.internalApi.getStyleForButton() usages)
             // with the next opportunity we should abstract it
-            const toolPanelContext = {
-                adaptableApi: props.api,
-                userName: props.api.optionsApi.getUserName(),
-                adaptableId: props.api.optionsApi.getAdaptableId(),
-                toolPanelState: props.api.toolPanelApi.getToolPanelState(),
-            };
+            const toolPanelContext = Object.assign(Object.assign({}, props.api.internalApi.buildBaseContext()), { toolPanelState: props.api.toolPanelApi.getToolPanelState() });
             const buttonIcon = props.api.internalApi.getIconForButton(button, toolPanelContext);
             let buttonStyle = props.api.internalApi.getStyleForButton(button, toolPanelContext);
             let buttonLabel = props.api.internalApi.getLabelForButton(button, toolPanelContext);

package/src/View/Components/ToolPanel/CustomToolPanelContent.js

@@ -15,14 +15,7 @@ export const CustomToolPanelContent = (props) => {
     useLayoutEffect(() => {
         const element = contentsDivDomRef.current;
         if (hasCustomRenderFn(customToolPanel)) {
-            const customRenderContext = {
-                visible: true,
-                phase: 'onMount',
-                element,
-                adaptableApi: api,
-                userName: api.optionsApi.getUserName(),
-                adaptableId: api.optionsApi.getAdaptableId(),
-            };
+            const customRenderContext = Object.assign({ visible: true, phase: 'onMount', element }, api.internalApi.buildBaseContext());
             const html = customToolPanel.render(customRenderContext);
             setContentsHTML(html);
         }
@@ -31,14 +24,7 @@ export const CustomToolPanelContent = (props) => {
         }
         return () => {
             if (hasCustomRenderFn(customToolPanel)) {
-                customToolPanel.render({
-                    visible: false,
-                    phase: 'onDestroy',
-                    element,
-                    adaptableApi: api,
-                    userName: api.optionsApi.getUserName(),
-                    adaptableId: api.optionsApi.getAdaptableId(),
-                });
+                customToolPanel.render(Object.assign({ visible: false, phase: 'onDestroy', element }, api.internalApi.buildBaseContext()));
             }
             else if (hasCustomFrameworkComponent(customToolPanel) && !api.isDestroyed()) {
                 api.internalApi.destroyFrameworkComponent(element, customToolPanel.frameworkComponent, 'toolPanel');
@@ -50,13 +36,7 @@ export const CustomToolPanelContent = (props) => {
         ((_a = customToolPanel.buttons) === null || _a === void 0 ? void 0 : _a.length) && (React.createElement("div", { id: buttonsDivId, className: `ab-ToolPanel__custom-content__buttons ${buttonsDivId}` }, customToolPanel.buttons.map((button) => {
             // TODO: variants of this mapping are present in several places (just search for api.internalApi.getStyleForButton() usages)
             // with the next opportunity we should abstract it
-            const toolPanelContext = {
-                adaptableApi: api,
-                userName: api.optionsApi.getUserName(),
-                adaptableId: api.optionsApi.getAdaptableId(),
-                toolPanelState: api.toolPanelApi.getToolPanelState(),
-                customToolPanel: customToolPanel,
-            };
+            const toolPanelContext = Object.assign(Object.assign({}, api.internalApi.buildBaseContext()), { toolPanelState: api.toolPanelApi.getToolPanelState(), customToolPanel: customToolPanel });
             const buttonIcon = api.internalApi.getIconForButton(button, toolPanelContext);
             let buttonStyle = api.internalApi.getStyleForButton(button, toolPanelContext);
             let buttonLabel = api.internalApi.getLabelForButton(button, toolPanelContext);

package/src/View/Components/ToolPanel/ToolPanelPopup.js

@@ -22,7 +22,6 @@ class ToolPanelPopupComponent extends React.Component {
         };
     }
     render() {
-        const entitlementService = this.props.api.internalApi.getEntitlementService();
         // 1. process module buttons
         const selectedModuleButtons = [];
         if (ArrayExtensions.IsNotNullOrEmpty(this.props.ToolPanelState.ModuleButtons)) {
@@ -37,15 +36,15 @@ class ToolPanelPopupComponent extends React.Component {
         // 2. process tool panels
         const availableModules = this.props.GridState.SettingPanelModuleMenuItems.filter((menuItem) => menuItem.isVisible).map((menuItem) => menuItem.module);
         // 'Dashboard' is a special case because it's not available in the dashboard menu items, s we have to add it manually
-        if (!entitlementService.isModuleHiddenEntitlement('Dashboard')) {
+        if (!this.props.api.entitlementApi.isModuleHiddenEntitlement('Dashboard')) {
             availableModules.push('Dashboard');
         }
         if (this.props.api.pluginsApi.getipushpullPluginApi() &&
-            !entitlementService.isModuleHiddenEntitlement('IPushPull')) {
+            !this.props.api.entitlementApi.isModuleHiddenEntitlement('IPushPull')) {
             availableModules.push('IPushPull');
         }
         if (this.props.api.pluginsApi.getOpenFinPluginApi() &&
-            !entitlementService.isModuleHiddenEntitlement('OpenFin')) {
+            !this.props.api.entitlementApi.isModuleHiddenEntitlement('OpenFin')) {
             availableModules.push('OpenFin');
         }
         const availableModuleToolPanels = ALL_TOOL_PANELS.filter((moduleToolPanel) => ArrayExtensions.ContainsItem(availableModules, moduleToolPanel));
@@ -59,7 +58,7 @@ class ToolPanelPopupComponent extends React.Component {
         const selectedToolPanels = this.props.ToolPanelState.ToolPanels.map((toolPanelDefinition) => toolPanelDefinition.Name)
             // ensure that the visible state has only valid tool panels
             .filter((visibleToolPanel) => availableToolPanels.includes(visibleToolPanel));
-        const isToolPanelReadOnly = entitlementService.isModuleReadOnlyEntitlement('ToolPanel');
+        const isToolPanelReadOnly = this.props.api.entitlementApi.isModuleReadOnlyEntitlement('ToolPanel');
         const isModuleCheckboxDisabled = (module) => {
             if (module === 'SettingsPanel') {
                 return this.props.api.optionsApi.getSettingsPanelOptions().alwaysShowInDashboard;

package/src/View/Components/ToolPanel/ToolPanelWrapper.js

@@ -13,9 +13,7 @@ export const ToolPanelWrapper = (props) => {
     const getToolPanelConfiguration = () => {
         var _a;
         if (adaptableToolPanel) {
-            const accessLevel = api.internalApi
-                .getEntitlementService()
-                .getEntitlementAccessLevelForModule(adaptableToolPanel);
+            const accessLevel = api.entitlementApi.getEntitlementAccessLevelForModule(adaptableToolPanel);
             const moduleInfo = api.internalApi
                 .getModuleService()
                 .getModuleInfoByModule(adaptableToolPanel);

package/src/View/Components/ValueSelector/index.js

@@ -7,9 +7,9 @@ import { Icon } from '../../../components/icons';
 import { EllipsisContainer } from '../../../components/EllipsisContainer';
 import SimpleButton from '../../../components/SimpleButton';
 import Radio from '../../../components/Radio';
-import { reorder } from '../../../Utilities/reorder';
 import { Tag } from '../../../components/Tag';
 import { AdaptableFormControlTextClear } from '../Forms/AdaptableFormControlTextClear';
+import ArrayExtensions from '../../../Utilities/Extensions/ArrayExtensions';
 function useValuesMap({ options, value, toIdentifier, selectedMap, }) {
     const optionsMap = useMemo(() => {
         if (selectedMap) {
@@ -130,7 +130,7 @@ export function ValueSelector(props) {
                     }
                 }
                 const clone = new Map(selectedMap);
-                const newSelection = reorder(selection, source.index, destination.index);
+                const newSelection = ArrayExtensions.reorderArray(selection, source.index, destination.index);
                 // and then pushed back in the new order, at the end
                 newSelection.push(...extraKeys);
                 selectedMap.clear();

package/src/View/CustomSort/Wizard/CustomSortValuesWizardSection.js

@@ -5,9 +5,9 @@ import { Loader } from '../../../components/Loader';
 import { Tabs } from '../../../components/Tabs';
 import join from '../../../components/utils/join';
 import { runIfNotResolvedIn } from '../../../Utilities/runIfNotResolvedIn';
-import { sortWithOrderArray } from '../../../Utilities/sortWithOrder';
 import { ValueOptionsTags, ValueSelector } from '../../Components/ValueSelector';
 import { useOnePageAdaptableWizardContext } from '../../Wizard/OnePageAdaptableWizard';
+import ArrayExtensions from '../../.././Utilities/Extensions/ArrayExtensions';
 export const isValidCustomSortOrder = (data) => {
     if (!data.SortedValues || !data.SortedValues.length) {
         return 'You have to specify at least one value for Custom Sort order';
@@ -51,7 +51,7 @@ export const CustomSortValuesWizardSection = (props) => {
         return sortedValuesMap.has(option);
     }, [sortedValuesMap]);
     const options = useMemo(() => {
-        return sortWithOrderArray(distinctValues, data.SortedValues, {
+        return ArrayExtensions.sortArrayWithOrder(distinctValues, data.SortedValues, {
             sortUnorderedItems: false,
         });
     }, [allowReorder, distinctValues, data.SortedValues]);

package/src/View/Dashboard/CustomDashboardButton.js

@@ -7,12 +7,7 @@ export const CustomDashboardButton = (props) => {
     const [componentRevision, setComponentRevision] = useState(1);
     // TODO: variants of this mapping are present in several places (just search for api.internalApi.getStyleForButton() usages)
     // with the next opportunity we should abstract it
-    const dashboardContext = {
-        adaptableApi: props.api,
-        userName: props.api.optionsApi.getUserName(),
-        adaptableId: props.api.optionsApi.getAdaptableId(),
-        dashboardState: props.api.dashboardApi.getDashboardState(),
-    };
+    const dashboardContext = Object.assign(Object.assign({}, props.api.internalApi.buildBaseContext()), { dashboardState: props.api.dashboardApi.getDashboardState() });
     const buttonIcon = props.api.internalApi.getIconForButton(button, dashboardContext);
     let buttonStyle = props.api.internalApi.getStyleForButton(button, dashboardContext);
     let buttonLabel = props.api.internalApi.getLabelForButton(button, dashboardContext);