@adaptabletools/adaptable 11.0.0-canary.3 → 11.0.0-canary.4

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

@@ -9,19 +9,12 @@ const icons_1 = require("../../../../components/icons");
 const join_1 = tslib_1.__importDefault(require("../../../../components/utils/join"));
 const useGlobalEvent_1 = require("../../../../components/utils/useGlobalEvent");
 exports.Navigation = (props) => {
-    var _a;
     const dispatch = react_redux_1.useDispatch();
     const handleKeyPress = React.useCallback((event) => {
         if ((event.ctrlKey || event.metaKey) &&
             (event.code === 'ArrowUp' || event.code === 'ArrowDown')) {
             const isKeyUp = event.code === 'ArrowUp';
-            const currentIndex = props.menuItems.findIndex((item) => {
-                var _a, _b;
-                return item !== '-' &&
-                    (item.module === ((_a = props === null || props === void 0 ? void 0 : props.moduleInfo) === null || _a === void 0 ? void 0 : _a.ModuleName) ||
-                        // in case of custom panel
-                        item.label === ((_b = props === null || props === void 0 ? void 0 : props.activeCustomSettingPanel) === null || _b === void 0 ? void 0 : _b.name));
-            });
+            const currentIndex = props.menuItems.findIndex((item) => item !== '-' && (item.module === props.activeItem || item.label === props.activeItem));
             let nextMenuItem = null;
             if (isKeyUp) {
                 let candidate = props.menuItems[currentIndex - 1] !== '-'
@@ -39,19 +32,18 @@ exports.Navigation = (props) => {
                 dispatch(nextMenuItem.reduxAction);
             }
         }
-    }, [(_a = props.moduleInfo) === null || _a === void 0 ? void 0 : _a.ModuleName, props.menuItems]);
+    }, [props.activeItem, props.menuItems]);
     useGlobalEvent_1.useGlobalEvent('keydown', handleKeyPress);
     return (React.createElement("nav", { className: "ab-Adaptable-Popup__Navigation" },
         React.createElement("ul", { className: "ab-Adaptable-Popup__Navigation__List" }, props.menuItems.map((menuItem, index) => {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d;
             const baseClassName = 'ab-Adaptable-Popup__Navigation__List__Item';
             if (menuItem === '-') {
                 return React.createElement("li", { key: `separator-${index}`, className: `${baseClassName}__Separator` });
             }
-            const isActive = ((_a = props === null || props === void 0 ? void 0 : props.moduleInfo) === null || _a === void 0 ? void 0 : _a.ModuleName) === menuItem.module ||
-                menuItem.label === ((_b = props === null || props === void 0 ? void 0 : props.activeCustomSettingPanel) === null || _b === void 0 ? void 0 : _b.name);
+            const isActive = props.activeItem === menuItem.module || menuItem.label === props.activeItem;
             const className = join_1.default(baseClassName, isActive && `${baseClassName}--active`);
-            let customIcon = (_f = (_e = (_d = (_c = props.customSettingsPanels) === null || _c === void 0 ? void 0 : _c.find) === null || _d === void 0 ? void 0 : _d.call(_c, (customSettingPanel) => customSettingPanel.name === menuItem.label)) === null || _e === void 0 ? void 0 : _e.icon) !== null && _f !== void 0 ? _f : null;
+            let customIcon = (_d = (_c = (_b = (_a = props.customSettingsPanels) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, (customSettingPanel) => customSettingPanel.name === menuItem.label)) === null || _c === void 0 ? void 0 : _c.icon) !== null && _d !== void 0 ? _d : null;
             return (React.createElement("li", { className: className, key: menuItem.label },
                 React.createElement("button", { type: "button", className: `${baseClassName}__Button`, onClick: () => {
                         dispatch(menuItem.reduxAction);

package/src/View/Components/Popups/AdaptablePopup/useMenuItems.d.ts

@@ -0,0 +1,2 @@
+import { AdaptableMenuItem } from '../../../../../types';
+export declare const useMenuItems: () => (AdaptableMenuItem | '-')[];

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useMenuItems = void 0;
+const tslib_1 = require("tslib");
+const React = tslib_1.__importStar(require("react"));
+const react_redux_1 = require("react-redux");
+const DefaultSettingsPanel_1 = require("../../../../Utilities/Defaults/DefaultSettingsPanel");
+const AdaptableContext_1 = require("../../../AdaptableContext");
+const PopupRedux = tslib_1.__importStar(require("../../../../Redux/ActionsReducers/PopupRedux"));
+exports.useMenuItems = () => {
+    const adaptable = AdaptableContext_1.useAdaptable();
+    const settingsPanelOptions = adaptable.adaptableOptions.settingsPanelOptions;
+    const allMenuItems = react_redux_1.useSelector((state) => { var _a; return (_a = state === null || state === void 0 ? void 0 : state.Grid) === null || _a === void 0 ? void 0 : _a.ModuleDropdownMenuItems; });
+    return React.useMemo(() => {
+        var _a;
+        let navigationItems = (_a = settingsPanelOptions === null || settingsPanelOptions === void 0 ? void 0 : settingsPanelOptions.navigation) === null || _a === void 0 ? void 0 : _a.items;
+        if (!navigationItems) {
+            navigationItems = [...DefaultSettingsPanel_1.DEFAULT_NAVIGATION_ITEMS];
+            if (settingsPanelOptions.customSettingsPanels) {
+                navigationItems.push(...settingsPanelOptions.customSettingsPanels.map((panel) => panel.name));
+            }
+        }
+        const visibleItems = allMenuItems.filter((item) => item.module !== 'General' && !DefaultSettingsPanel_1.ACTION_POPUPS.includes(item.module) && item.isVisible);
+        return navigationItems
+            .map((moduleName) => {
+            var _a, _b;
+            if (moduleName === '-') {
+                return moduleName;
+            }
+            const customSettingsPanel = (_b = (_a = settingsPanelOptions === null || settingsPanelOptions === void 0 ? void 0 : settingsPanelOptions.customSettingsPanels) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, (panel) => panel.name === moduleName);
+            let customPanelMenuItem = null;
+            if (customSettingsPanel) {
+                customPanelMenuItem = {
+                    label: customSettingsPanel.name,
+                    module: 'CustomSettingsPanelModule',
+                    isVisible: true,
+                    reduxAction: PopupRedux.PopupShowScreen('CustomSettingsPanelModule', customSettingsPanel.name),
+                };
+            }
+            return customPanelMenuItem || visibleItems.find((item) => item.module === moduleName);
+        })
+            .filter(Boolean);
+    }, [allMenuItems]);
+};

package/src/View/Dashboard/Dashboard.js

@@ -69,8 +69,7 @@ const DashboardComponent = (props) => {
     const renderModuleButtons = () => {
         let shortcutsArray = props.DashboardState.ModuleButtons;
         let shortcuts = null;
-        const alwaysShowInDashboard = props.api.internalApi.getAdaptableOptions().settingsPanelOptions
-            .alwaysShowInDashboard;
+        const alwaysShowInDashboard = props.api.internalApi.getAdaptableOptions().settingsPanelOptions.alwaysShowInDashboard;
         const shouldAddSettingsPanel = alwaysShowInDashboard &&
             !props.api.internalApi.getEntitlementService().isModuleHiddenEntitlement('SettingsPanel');
         if (shouldAddSettingsPanel && !shortcutsArray.includes('SettingsPanel')) {

package/src/View/SpecialColumnSettingsWizardStep.js

@@ -12,8 +12,7 @@ const AdaptableContext_1 = require("./AdaptableContext");
 exports.SpecialColumnSettingsWizardStep = (props) => {
     var _a, _b;
     const adaptable = AdaptableContext_1.useAdaptable();
-    const possibleColumnTypes = adaptable.api.internalApi.getAdaptableOptions().userInterfaceOptions
-        .columnTypes;
+    const possibleColumnTypes = adaptable.api.internalApi.getAdaptableOptions().userInterfaceOptions.columnTypes;
     const { Filterable, Resizable, Groupable, Sortable, Pivotable, Aggregatable, SuppressMenu, SuppressMovable, } = (_a = props.settings) !== null && _a !== void 0 ? _a : {};
     const handleColumnTypeChange = (columnType, checked) => {
         var _a, _b, _c;

package/src/agGrid/Adaptable.js

@@ -340,7 +340,8 @@ class Adaptable {
         // TODO: if  a custom 'aggFunc' property is defined (see setupColumnAggFunc()), it won't be evaluated
         if (!this.getDefaultGroupOrderComparator(this.gridOptions) &&
             this.adaptableOptions.generalOptions.autoOrderGroupedColumns) {
-            this.gridOptions.defaultGroupOrderComparator = this.agGridHelper.runAdaptableGroupComparerFunction();
+            this.gridOptions.defaultGroupOrderComparator =
+                this.agGridHelper.runAdaptableGroupComparerFunction();
         }
         // we prefer the grid to be NOT instantiated so that we can do it
         // perhaps in future we will force instantiation only?
@@ -1942,10 +1943,8 @@ class Adaptable {
         ];
     }
     getColDefsForFreeTextColumns() {
-        const specialColumnsAreFilterable = this.api.internalApi.getAdaptableOptions().filterOptions
-            .enableFilterOnSpecialColumns;
-        const defaultFreeTextColumnSettings = ObjectFactory_1.CreateEmptyFreeTextColumn(specialColumnsAreFilterable)
-            .FreeTextColumnSettings;
+        const specialColumnsAreFilterable = this.api.internalApi.getAdaptableOptions().filterOptions.enableFilterOnSpecialColumns;
+        const defaultFreeTextColumnSettings = ObjectFactory_1.CreateEmptyFreeTextColumn(specialColumnsAreFilterable).FreeTextColumnSettings;
         return this.api.freeTextColumnApi.getAllFreeTextColumn().map((freeTextColumn) => {
             var _a;
             const freeTextColumnSettings = Object.assign(Object.assign({}, defaultFreeTextColumnSettings), freeTextColumn.FreeTextColumnSettings);
@@ -2089,13 +2088,13 @@ class Adaptable {
             .enableFilterOnSpecialColumns
             ? this.adaptableOptions.filterOptions.enableFilterOnSpecialColumns
             : true;
-        const defaultCalculatedColumnSettings = ObjectFactory_1.CreateEmptyCalculatedColumn(specialColumnsAreFilterable)
-            .CalculatedColumnSettings;
+        const defaultCalculatedColumnSettings = ObjectFactory_1.CreateEmptyCalculatedColumn(specialColumnsAreFilterable).CalculatedColumnSettings;
         return this.api.calculatedColumnApi.getAllCalculatedColumn().map((calculatedColumn) => {
             var _a;
             const calculatedColumnSettings = Object.assign(Object.assign({}, defaultCalculatedColumnSettings), calculatedColumn.CalculatedColumnSettings);
             if (!calculatedColumnSettings.DataType) {
-                calculatedColumnSettings.DataType = this.CalculatedColumnExpressionService.GetCalculatedColumnDataType((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression);
+                calculatedColumnSettings.DataType =
+                    this.CalculatedColumnExpressionService.GetCalculatedColumnDataType((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression);
             }
             const columnTypes = [
                 GeneralConstants_1.AB_SPECIAL_COLUMN,
@@ -2474,8 +2473,7 @@ class Adaptable {
             this.onSortChanged();
             this.debouncedSetSelectedCells();
         });
-        const showGroupingTotalsAsHeader = this.adaptableOptions.generalOptions
-            .showGroupingTotalsAsHeader;
+        const showGroupingTotalsAsHeader = this.adaptableOptions.generalOptions.showGroupingTotalsAsHeader;
         /**
          * Use Case: Model has updated
          * Action: If user has set to see grouping totals as header create a pinned row (bit of a hack)
@@ -2909,8 +2907,7 @@ class Adaptable {
             // set the default to the AG Grid provided values
             // from https://github.com/ag-grid/ag-grid/blob/v26.1.0/community-modules/core/src/ts/columns/columnModel.ts#L2515
             let resultHeaderName = userHeaderName !== null && userHeaderName !== void 0 ? userHeaderName : StringExtensions_1.StringExtensions.CamelCaseToHumanText(col.getColDef().field);
-            const layoutCustomHeader = (_a = this.api.layoutApi.getCurrentLayout()
-                .ColumnHeadersMap) === null || _a === void 0 ? void 0 : _a[col.getColId()];
+            const layoutCustomHeader = (_a = this.api.layoutApi.getCurrentLayout().ColumnHeadersMap) === null || _a === void 0 ? void 0 : _a[col.getColId()];
             if (layoutCustomHeader) {
                 resultHeaderName = layoutCustomHeader;
             }

package/src/agGrid/agGridHelper.js

@@ -248,8 +248,7 @@ class agGridHelper {
             }
         }
         // lets set this here one as the function cannot change the result so dont need to run it each time
-        let excludeColumnFromQuickSearch = this.adaptable.adaptableOptions.searchOptions
-            .excludeColumnFromQuickSearch;
+        let excludeColumnFromQuickSearch = this.adaptable.adaptableOptions.searchOptions.excludeColumnFromQuickSearch;
         if (excludeColumnFromQuickSearch) {
             if (excludeColumnFromQuickSearch(abColumn)) {
                 abColumn.isExcludedFromQuickSearch = true;

package/src/agGrid/agGridMenuHelper.js

@@ -21,8 +21,7 @@ class agGridMenuHelper {
         let userColumnMenuItems = [];
         //First get Ag Grid Column Items
         agGridColumnMenuItems.push(...this.createAgGridColumnMenuItems(originalgetMainMenuItems, params));
-        let showAdaptableColumnMenu = this.adaptable.adaptableOptions.menuOptions
-            .showAdaptableColumnMenu;
+        let showAdaptableColumnMenu = this.adaptable.adaptableOptions.menuOptions.showAdaptableColumnMenu;
         let hasAdaptableColumnMenuItems = showAdaptableColumnMenu == null || showAdaptableColumnMenu !== false;
         if (hasAdaptableColumnMenuItems) {
             agGridColumnMenuItems.push('separator');
@@ -56,8 +55,7 @@ class agGridMenuHelper {
         let agGridContextMenuItems = [];
         let adaptableContextMenuItems = [];
         let userContextMenuItems = [];
-        let showAdaptableContextMenu = this.adaptable.adaptableOptions.menuOptions
-            .showAdaptableContextMenu;
+        let showAdaptableContextMenu = this.adaptable.adaptableOptions.menuOptions.showAdaptableContextMenu;
         let hasAdaptableContextMenuItems = showAdaptableContextMenu == null || showAdaptableContextMenu !== false;
         let userDefinedContextMenuItems = this.adaptable.adaptableOptions.menuOptions.contextMenuItems;
         let hasUserDefinedContextMenuItems = ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(userDefinedContextMenuItems);
@@ -285,8 +283,7 @@ class agGridMenuHelper {
         // here we create agGrid Menu items based on Adaptable Menu Items
         // user has ability to decide whether to show or not
         let contextMenuItems = [];
-        let showAdaptableContextMenu = this.adaptable.adaptableOptions.menuOptions
-            .showAdaptableContextMenu;
+        let showAdaptableContextMenu = this.adaptable.adaptableOptions.menuOptions.showAdaptableContextMenu;
         if (showAdaptableContextMenu == null || showAdaptableContextMenu !== false) {
             adaptableMenuItems.forEach((adaptableMenuItem) => {
                 if (adaptableMenuItem) {
@@ -321,8 +318,7 @@ class agGridMenuHelper {
     // method to get all the Adaptable Menu Items - together with running the function where user can choose whether or not to display
     getAdaptableMenuItemsColumnHeader(adaptableColumn, menuContext) {
         const adaptableMenuItems = [];
-        let showAdaptableColumnMenu = this.adaptable.adaptableOptions.menuOptions
-            .showAdaptableColumnMenu;
+        let showAdaptableColumnMenu = this.adaptable.adaptableOptions.menuOptions.showAdaptableColumnMenu;
         let runCheck = showAdaptableColumnMenu == null || showAdaptableColumnMenu !== false;
         //  if (adaptableColumn != null) {
         this.adaptable.adaptableModules.forEach((s) => {

package/src/metamodel/adaptable.metamodel.d.ts

@@ -873,6 +873,14 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
+            reference?: undefined;
+            isOptional?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
             isOptional?: undefined;
         } | {
             name: string;
@@ -880,6 +888,7 @@ export declare const ADAPTABLE_METAMODEL: {
             description: string;
             uiLabel: string;
             isOptional: boolean;
+            reference?: undefined;
         })[];
     };
     CellSummaryApi: {

package/src/metamodel/adaptable.metamodel.js

@@ -2245,6 +2245,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Id of Column containing Cell",
                 "uiLabel": "Column Id"
             },
+            {
+                "name": "highlightStyle",
+                "kind": "REFERENCE",
+                "description": "Adaptable Style to use in the Cell Highlight",
+                "uiLabel": "Highlight Style",
+                "reference": "AdaptableStyle"
+            },
             {
                 "name": "primaryKeyValue",
                 "kind": "unknown",

package/src/types.d.ts

@@ -107,7 +107,8 @@ export type { FDC3Context, InstrumentContext } from './PredefinedConfig/Common/F
 export type { AdaptableScope } from './PredefinedConfig/Common/AdaptableScope';
 export type { AdaptableStyle } from './PredefinedConfig/Common/AdaptableStyle';
 export type { AdaptableIcon } from './PredefinedConfig/Common/AdaptableIcon';
-export type { CellHighlightInfo, RowHighlightInfo, } from './PredefinedConfig/Common/CellHighlightInfo';
+export type { CellHighlightInfo } from './PredefinedConfig/Common/CellHighlightInfo';
+export type { RowHighlightInfo } from './PredefinedConfig/Common/RowHighlightInfo';
 export type { ColumnSort } from './PredefinedConfig/Common/ColumnSort';
 export type { DataChangedInfo } from './PredefinedConfig/Common/DataChangedInfo';
 export type { DataUpdateConfig } from './PredefinedConfig/Common/DataUpdateConfig';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.0-canary.3";
+declare const _default: "11.0.0-canary.4";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.0.0-canary.3'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.0.0-canary.4'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version