@adaptabletools/adaptable 18.0.0-canary.26 → 18.0.0-canary.27

package/src/agGrid/AgGridMenuAdapter.js

@@ -1,4 +1,3 @@
-import { DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE, DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE, } from '../AdaptableOptions/MenuOptions';
 import { isAdaptableElementIcon } from '../components/Icon';
 import { iconToString } from '../components/icons';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
@@ -25,7 +24,8 @@ export class AgGridMenuAdapter {
         }
         const adaptableColumn = this.adaptableApi.columnApi.getColumnWithColumnId((_a = params.column) === null || _a === void 0 ? void 0 : _a.getColId());
         const menuContext = this.createColumnMenuContextObject(adaptableColumn, params.column);
-        const { adaptableMenuItems, structuredAdaptableMenuItems } = this.buildStructuredAdaptableColumnItems(menuContext);
+        const adaptableMenuItems = this.createAdaptableColumnMenuItems(menuContext);
+        const defaultColumnMenuStructure = this.buildColumnMenuDefaultStructure(adaptableMenuItems, menuContext);
         // 1. first check if there is a custom column menu defined
         if (typeof menuOptions.customColumnMenu === 'function') {
             const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => ({
@@ -35,7 +35,7 @@ export class AgGridMenuAdapter {
             const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
             const customMenuItems = menuOptions
                 .customColumnMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
-                defaultAdaptableMenuItems, structuredAdaptableMenuItems: this.mapAdaptableMenuItemToSystemMenuItems(structuredAdaptableMenuItems) }))
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultColumnMenuStructure) }))
                 .filter(Boolean);
             return customMenuItems
                 .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
@@ -45,16 +45,10 @@ export class AgGridMenuAdapter {
         const defaultContextMenu = [
             ...agGridMenuItems,
             'separator',
-            ...structuredAdaptableMenuItems.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
+            ...defaultColumnMenuStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
         ];
         return defaultContextMenu;
     }
-    buildStructuredAdaptableColumnItems(menuContext) {
-        const adaptableMenuItems = this.createAdaptableColumnMenuItems(menuContext);
-        // sort Adaptable menu items by default order
-        const structuredAdaptableMenuItems = this.buildGroupedModuleItems(DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE, adaptableMenuItems);
-        return { adaptableMenuItems, structuredAdaptableMenuItems };
-    }
     buildContextMenu(params, originalGetContextMenuItems) {
         var _a;
         // we do this in order to refresh the internal state of selected cells (technically query the AG Grid cellRanges)
@@ -69,8 +63,7 @@ export class AgGridMenuAdapter {
         const adaptableColumn = this.adaptableApi.columnApi.getColumnWithColumnId((_a = params.column) === null || _a === void 0 ? void 0 : _a.getColId());
         const menuContext = this.createContextMenuContextObject(params, adaptableColumn);
         const adaptableMenuItems = this.createAdaptableContextMenuItems(menuContext);
-        // sort Adaptable menu items by default order
-        const structuredAdaptableMenuItems = this.buildGroupedModuleItems(DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE, adaptableMenuItems);
+        const defaultContextMenuStructure = this.buildContextMenuDefaultStructure(adaptableMenuItems, menuContext);
         // 1. first check if there is a custom context menu defined
         if (typeof menuOptions.customContextMenu === 'function') {
             const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => ({
@@ -80,7 +73,7 @@ export class AgGridMenuAdapter {
             const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
             const customMenuItems = menuOptions
                 .customContextMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
-                defaultAdaptableMenuItems, structuredAdaptableMenuItems: this.mapAdaptableMenuItemToSystemMenuItems(structuredAdaptableMenuItems) }))
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultContextMenuStructure) }))
                 .filter(Boolean);
             return customMenuItems
                 .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
@@ -90,7 +83,7 @@ export class AgGridMenuAdapter {
         const defaultContextMenu = [
             ...agGridMenuItems,
             'separator',
-            ...structuredAdaptableMenuItems.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
+            ...defaultContextMenuStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
         ];
         return defaultContextMenu;
     }
@@ -100,7 +93,7 @@ export class AgGridMenuAdapter {
     createAdaptableContextMenuItems(menuContext) {
         let contextMenuItems = [];
         this.adaptableInstance.adaptableModules.forEach((module) => {
-            let menuItems = module.addContextMenuItems(menuContext);
+            let menuItems = module.createContextMenuItems(menuContext);
             if (menuItems) {
                 contextMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
             }
@@ -197,40 +190,232 @@ export class AgGridMenuAdapter {
             }).filter(Boolean),
         };
     }
-    buildGroupedModuleItems(sortedMenuItems, adaptableMenuItems) {
-        return sortedMenuItems
-            .map((moduleOrGroup) => {
-            if (typeof moduleOrGroup === 'object') {
-                const submenuItems = this.buildGroupedModuleItems(moduleOrGroup.modules, adaptableMenuItems);
-                // if there is only one item in the submenu, we don't need to show the submenu
-                if (submenuItems.length === 1) {
-                    return submenuItems[0];
-                }
-                return [
-                    {
-                        label: moduleOrGroup.title,
-                        icon: moduleOrGroup.icon,
-                        subItems: submenuItems,
-                    },
-                ];
-            }
-            else {
-                return adaptableMenuItems.filter((menuItem) => menuItem.module === moduleOrGroup);
-            }
-        })
-            .filter((menuItems) => {
-            if (!menuItems.length) {
-                return false;
-            }
-            if (menuItems.length === 1) {
-                const singleMenuItem = menuItems[0];
-                if (singleMenuItem.subItems && singleMenuItem.subItems.length === 0) {
-                    return false;
-                }
-            }
-            return true;
-        })
-            .flat();
+    buildContextMenuDefaultStructure(availableMenuItems, menuContext) {
+        // Alert
+        const alertMenuItems = this.getModuleSpecificStructure('Alert', availableMenuItems);
+        // BulkUpdate
+        const bulkUpdateMenuItems = this.getModuleSpecificStructure('BulkUpdate', availableMenuItems);
+        // CalculatedColumn
+        const calculatedColumnMenuItems = this.getModuleSpecificStructure('CalculatedColumn', availableMenuItems);
+        // CellSummary
+        const cellSummaryMenuItems = this.getModuleSpecificStructure('CellSummary', availableMenuItems);
+        // ColumnFilter
+        const columnFilterMenuItems = this.getModuleSpecificStructure('ColumnFilter', availableMenuItems);
+        // ColumnInfo
+        const columnInfoMenuItems = this.getModuleSpecificStructure('ColumnInfo', availableMenuItems);
+        // Comment
+        const commentMenuItems = this.getModuleSpecificStructure('Comment', availableMenuItems);
+        // Dashboard
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        // DataImport
+        const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
+        // Export
+        const exportMenuItems = this.getExportContextMenuStructure(availableMenuItems);
+        // FDC3
+        const fdc3MenuItems = this.getModuleSpecificStructure('Fdc3', availableMenuItems);
+        // FlashingCell
+        const flashingCellMenuItems = this.getModuleSpecificStructure('FlashingCell', availableMenuItems);
+        // GridInfo
+        const gridInfoMenuItems = this.getModuleSpecificStructure('GridInfo', availableMenuItems);
+        // Layout
+        const layoutMenuItems = this.getLayoutContextMenuStructure(availableMenuItems);
+        // Note
+        const noteMenuItems = this.getModuleSpecificStructure('Note', availableMenuItems);
+        // SettingsPanel
+        const settingsPanelMenuItems = this.getModuleSpecificStructure('SettingsPanel', availableMenuItems);
+        // SmartEdit
+        const smartEditMenuItems = this.getModuleSpecificStructure('SmartEdit', availableMenuItems);
+        // SystemStatus
+        const systemStatusMenuItems = this.getModuleSpecificStructure('SystemStatus', availableMenuItems);
+        return [
+            ...alertMenuItems,
+            ...bulkUpdateMenuItems,
+            ...calculatedColumnMenuItems,
+            ...cellSummaryMenuItems,
+            ...columnFilterMenuItems,
+            ...columnInfoMenuItems,
+            ...commentMenuItems,
+            ...dashboardMenuItems,
+            ...dataImportMenuItems,
+            ...exportMenuItems,
+            ...fdc3MenuItems,
+            ...flashingCellMenuItems,
+            ...gridInfoMenuItems,
+            ...layoutMenuItems,
+            ...noteMenuItems,
+            ...settingsPanelMenuItems,
+            ...smartEditMenuItems,
+            ...systemStatusMenuItems,
+        ];
+    }
+    /**
+     * Default strategy for menu items: return as is if there is only one item, otherwise group them under a parent item
+     */
+    getModuleSpecificStructure(module, menuItems) {
+        const moduleItems = menuItems.filter((menuItem) => menuItem.module === module);
+        if (moduleItems.length > 1) {
+            const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
+            return [this.buildMenuGroupParent(module, moduleItems)];
+        }
+        else {
+            return moduleItems;
+        }
+    }
+    getExportContextMenuStructure(menuItems) {
+        const exportMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Export');
+        if (!exportMenuItems.length) {
+            return [];
+        }
+        const cellSelectionItems = exportMenuItems.filter((item) => item.name.startsWith('export-cells'));
+        const canExportCells = cellSelectionItems.length;
+        const rowSelectionItems = exportMenuItems.filter((item) => item.name.startsWith('export-rows'));
+        const canExportRows = rowSelectionItems.length;
+        if (canExportCells && !canExportRows) {
+            return [
+                this.buildMenuGroupParent('Export', cellSelectionItems, {
+                    label: 'Export Selected Cells',
+                }),
+            ];
+        }
+        if (!canExportCells && canExportRows) {
+            return [
+                this.buildMenuGroupParent('Export', rowSelectionItems, {
+                    label: 'Export Selected Rows',
+                }),
+            ];
+        }
+        if (canExportCells && canExportRows) {
+            const cellsSubMenu = this.buildMenuGroupParent('Export', cellSelectionItems, {
+                label: 'Cells',
+            });
+            const rowsSubMenu = this.buildMenuGroupParent('Export', rowSelectionItems, { label: 'Rows' });
+            return [
+                this.buildMenuGroupParent('Export', [cellsSubMenu, rowsSubMenu], {
+                    label: 'Export Selected',
+                }),
+            ];
+        }
+    }
+    getLayoutContextMenuStructure(menuItems) {
+        const layoutMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Layout');
+        if (!layoutMenuItems.length) {
+            return [];
+        }
+        const gridActionsItemNames = [
+            'layout-clear-selection',
+            'layout-select-all',
+            'layout-auto-size',
+        ];
+        const gridActionsItems = layoutMenuItems.filter((item) => gridActionsItemNames.includes(item.name));
+        const otherLayoutItems = layoutMenuItems.filter((item) => !gridActionsItemNames.includes(item.name));
+        return [
+            this.buildMenuGroupParent('Layout', gridActionsItems, {
+                label: 'Grid',
+                icon: 'align-justify',
+            }),
+            ...otherLayoutItems,
+        ];
+    }
+    buildMenuGroupParent(module, menuItems, config) {
+        var _a, _b;
+        const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
+        return {
+            name: 'menu-group-parent',
+            label: (_a = config === null || config === void 0 ? void 0 : config.label) !== null && _a !== void 0 ? _a : moduleInfo.FriendlyName,
+            isVisible: true,
+            module: moduleInfo.ModuleName,
+            icon: {
+                name: (_b = config === null || config === void 0 ? void 0 : config.icon) !== null && _b !== void 0 ? _b : moduleInfo.Glyph,
+            },
+            subItems: menuItems,
+        };
+    }
+    buildColumnMenuDefaultStructure(availableMenuItems, menuContext) {
+        // CalculatedColumn
+        const calculatedColumnMenuItems = this.getModuleSpecificStructure('CalculatedColumn', availableMenuItems);
+        // CellSummary
+        const cellSummaryMenuItems = this.getModuleSpecificStructure('CellSummary', availableMenuItems);
+        // ColumnFilter
+        const columnFilterMenuItems = this.getModuleSpecificStructure('ColumnFilter', availableMenuItems);
+        // ColumnInfo
+        const columnInfoMenuItems = this.getModuleSpecificStructure('ColumnInfo', availableMenuItems);
+        // CustomSort
+        const customSortMenuItems = this.getModuleSpecificStructure('CustomSort', availableMenuItems);
+        // Dashboard
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        // DataImport
+        const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
+        // FlashingCell
+        const flashingCellMenuItems = this.getModuleSpecificStructure('FlashingCell', availableMenuItems);
+        // FormatColumn
+        const formatColumnMenuItems = this.getModuleSpecificStructure('FormatColumn', availableMenuItems);
+        // FreeTextColumn
+        const freeTextColumnMenuItems = this.getModuleSpecificStructure('FreeTextColumn', availableMenuItems);
+        // GridInfo
+        const gridInfoMenuItems = this.getModuleSpecificStructure('GridInfo', availableMenuItems);
+        // Layout
+        const layoutMenuItems = this.getLayoutColumnMenuStructure(availableMenuItems);
+        // PlusMinus
+        const plusMinusMenuItems = this.getModuleSpecificStructure('PlusMinus', availableMenuItems);
+        // SettingsPanel
+        const settingsPanelMenuItems = this.getModuleSpecificStructure('SettingsPanel', availableMenuItems);
+        // StyledColumn
+        const styledColumnMenuItems = this.getStyledColumnColumnMenuStructure(availableMenuItems);
+        // SystemStatus
+        const systemStatusMenuItems = this.getModuleSpecificStructure('SystemStatus', availableMenuItems);
+        return [
+            ...calculatedColumnMenuItems,
+            ...cellSummaryMenuItems,
+            ...columnFilterMenuItems,
+            ...columnInfoMenuItems,
+            ...customSortMenuItems,
+            ...dashboardMenuItems,
+            ...dataImportMenuItems,
+            ...flashingCellMenuItems,
+            ...formatColumnMenuItems,
+            ...freeTextColumnMenuItems,
+            ...gridInfoMenuItems,
+            ...layoutMenuItems,
+            ...plusMinusMenuItems,
+            ...settingsPanelMenuItems,
+            ...styledColumnMenuItems,
+            ...systemStatusMenuItems,
+        ];
+    }
+    getLayoutColumnMenuStructure(menuItems) {
+        const layoutMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Layout');
+        if (!layoutMenuItems.length) {
+            return [];
+        }
+        const selectActionsItemNames = [
+            'layout-column-select-preserve',
+            'layout-column-select-reset',
+            'layout-column-select',
+            'layout-select-all',
+        ];
+        const selectActionsItems = layoutMenuItems.filter((item) => selectActionsItemNames.includes(item.name));
+        const otherLayoutItems = layoutMenuItems.filter((item) => !selectActionsItemNames.includes(item.name));
+        return [
+            ...otherLayoutItems,
+            this.buildMenuGroupParent('Layout', selectActionsItems, {
+                label: 'Select',
+                icon: 'tab-unselected',
+            }),
+        ];
+    }
+    getStyledColumnColumnMenuStructure(menuItems) {
+        const styledColumnMenuItems = menuItems.filter((menuItem) => menuItem.module === 'StyledColumn');
+        if (!styledColumnMenuItems.length) {
+            return [];
+        }
+        if (styledColumnMenuItems.length === 1) {
+            return styledColumnMenuItems;
+        }
+        return [
+            this.buildMenuGroupParent('StyledColumn', styledColumnMenuItems, {
+                label: 'Create Styled Column',
+            }),
+        ];
     }
     mapAdaptableMenuItemToSystemMenuItems(adaptableMenuItems) {
         return (adaptableMenuItems !== null && adaptableMenuItems !== void 0 ? adaptableMenuItems : []).map((menuItem) => {
@@ -244,7 +429,7 @@ export class AgGridMenuAdapter {
     createAdaptableColumnMenuItems(menuContext) {
         let contextMenuItems = [];
         this.adaptableInstance.adaptableModules.forEach((s) => {
-            let menuItems = s.addColumnMenuItems(menuContext.adaptableColumn);
+            let menuItems = s.createColumnMenuItems(menuContext.adaptableColumn);
             if (menuItems) {
                 contextMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
             }
@@ -269,9 +454,13 @@ export class AgGridMenuAdapter {
             });
         }
     }
+    /**
+     * The output of this function is used to build the column header menu if the AG Grid Menu Module is NOT present
+     * This is controlled by the AdaptableAgGrid.embedColumnMenu property
+     */
     buildStandaloneColumnHeader(adaptableColumn) {
         const agGridColumn = this.adaptableInstance.getAgGridColumnForColumnId(adaptableColumn.columnId);
         const menuContext = this.createColumnMenuContextObject(adaptableColumn, agGridColumn);
-        return this.buildStructuredAdaptableColumnItems(menuContext).adaptableMenuItems;
+        return this.createAdaptableColumnMenuItems(menuContext);
     }
 }

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1712574265503 || Date.now(),
-    VERSION: "18.0.0-canary.26" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1712613802729 || Date.now(),
+    VERSION: "18.0.0-canary.27" || '--current-version--',
 };