@adaptabletools/adaptable-cjs 18.0.0-canary.33 → 18.0.0-canary.35

package/src/agGrid/AgGridMenuAdapter.js

@@ -28,18 +28,19 @@ 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);
+        /**
+         * AG Grid items
+         */
+        const agGridDefaultStructure = agGridMenuItems.map((itemName) => this.mapAgGridItemTypeToAgGridMenuItem(itemName));
         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) => ({
-                menuType: 'AgGrid',
-                name: itemName,
-            }));
+            const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => this.mapAgGridItemTypeToAgGridMenuItem(itemName));
             const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
             const customMenuItems = menuOptions
                 .customColumnMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
-                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultColumnMenuStructure) }))
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultColumnMenuStructure), defaultAgGridMenuStructure: agGridDefaultStructure }))
                 .filter(Boolean);
             return customMenuItems
                 .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
@@ -55,56 +56,70 @@ class AgGridMenuAdapter {
     }
     buildContextMenu(params, originalGetContextMenuItems) {
         var _a;
+        if (!params.column) {
+            return [];
+        }
         // we do this in order to refresh the internal state of selected cells (technically query the AG Grid cellRanges)
         // (right-click selected the current cell, but this was not reflected in the internal state of the selected cells)
         this.adaptableInstance.refreshSelectedCellsState();
         const menuOptions = this.adaptableOptions.menuOptions;
-        const agGridMenuItems = (params.defaultItems ? [...params.defaultItems] : []);
-        if (!params.column) {
-            return [];
-        }
         const adaptableColumn = this.adaptableApi.columnApi.getColumnWithColumnId((_a = params.column) === null || _a === void 0 ? void 0 : _a.getColId());
         const menuContext = this.createContextMenuContextObject(params, adaptableColumn);
+        /**
+         * AG Grid Items
+         */
+        const agGridMenuItems = (params.defaultItems ? [...params.defaultItems] : []);
+        const agGridCopyItems = agGridMenuItems.filter((item) => ['copy', 'copyWithHeaders', 'copyWithGroupHeaders', 'cut', 'paste'].includes(item));
+        const otherAgGridItems = agGridMenuItems.filter((item) => !agGridCopyItems.includes(item) &&
+            // we provide Adaptable exports in the context menu
+            !['export', 'csvExport', 'excelExport'].includes(item));
+        const agGridDefaultStructure = [
+            {
+                menuType: 'Group',
+                label: 'Copy & Paste',
+                icon: {
+                    name: 'copy',
+                },
+                subMenuItems: agGridCopyItems.map((item) => this.mapAgGridItemTypeToAgGridMenuItem(item)),
+            },
+            ...otherAgGridItems
+                .filter((itemName) => itemName !== 'separator')
+                .map((itemName) => this.mapAgGridItemTypeToAgGridMenuItem(itemName)),
+        ];
+        /**
+         * Adaptable Items
+         */
         const adaptableMenuItems = this.createAdaptableContextMenuItems(menuContext);
-        const defaultContextMenuStructure = this.buildContextMenuDefaultStructure(adaptableMenuItems, menuContext);
+        const adaptableDefaultStructure = this.buildContextMenuDefaultStructure(adaptableMenuItems, menuContext);
+        /**
+         * Build the context menu
+         */
         // 1. first check if there is a custom context menu defined
         if (typeof menuOptions.customContextMenu === 'function') {
-            const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => ({
-                menuType: 'AgGrid',
-                name: itemName,
-            }));
+            const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => this.mapAgGridItemTypeToAgGridMenuItem(itemName));
             const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
             const customMenuItems = menuOptions
                 .customContextMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
-                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultContextMenuStructure) }))
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(adaptableDefaultStructure), defaultAgGridMenuStructure: agGridDefaultStructure }))
                 .filter(Boolean);
             return customMenuItems
                 .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
                 .filter(Boolean);
         }
         // 2. if not, return the default context menu
-        const agGridCopyItems = agGridMenuItems.filter((item) => ['copy', 'copyWithHeaders', 'copyWithGroupHeaders', 'cut', 'paste'].includes(item));
-        const otherAgGridItems = agGridMenuItems.filter((item) => !agGridCopyItems.includes(item) &&
-            // we provide Adaptable exports in the context menu
-            !['export', 'csvExport', 'excelExport'].includes(item));
         const defaultContextMenu = [
-            this.mapCustomMenuItemToAgGridMenuDefinition({
-                menuType: 'Group',
-                label: 'Copy & Paste',
-                icon: {
-                    name: 'copy',
-                },
-                subMenuItems: agGridCopyItems.map((item) => ({
-                    menuType: 'AgGrid',
-                    name: item,
-                })),
-            }, menuContext),
-            ...otherAgGridItems,
+            ...agGridDefaultStructure.map((agGridItem) => this.mapCustomMenuItemToAgGridMenuDefinition(agGridItem, menuContext)),
             'separator',
-            ...defaultContextMenuStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
+            ...adaptableDefaultStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
         ];
         return this.removeConsecutiveSeparators(defaultContextMenu);
     }
+    mapAgGridItemTypeToAgGridMenuItem(itemName) {
+        return {
+            menuType: 'AgGrid',
+            name: itemName,
+        };
+    }
     // due to entitlements or other reasons, some menu items might be hidden, leading to consecutive separators
     removeConsecutiveSeparators(menuItems, separator = 'separator') {
         return menuItems.reduce((acc, item, index, array) => {
@@ -237,7 +252,7 @@ class AgGridMenuAdapter {
         // Comment
         const commentMenuItems = this.getModuleSpecificStructure('Comment', availableMenuItems);
         // Dashboard
-        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems, 'dashboard-group');
         // DataImport
         const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
         // Export
@@ -264,8 +279,7 @@ class AgGridMenuAdapter {
         const gridMenuItem = {
             name: 'grid-group',
             label: 'Grid',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'grid',
@@ -282,8 +296,7 @@ class AgGridMenuAdapter {
         const editMenuItem = {
             name: 'edit-group',
             label: 'Edit',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'edit-table',
@@ -293,8 +306,7 @@ class AgGridMenuAdapter {
         const columnMenuItem = {
             name: 'column-group',
             label: 'Column',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'columns',
@@ -336,11 +348,11 @@ class AgGridMenuAdapter {
     /**
      * Default strategy for menu items: return as is if there is only one item, otherwise group them under a parent item
      */
-    getModuleSpecificStructure(module, menuItems) {
+    getModuleSpecificStructure(module, menuItems, groupName) {
         const moduleItems = menuItems.filter((menuItem) => menuItem.module === module);
         if (moduleItems.length > 1) {
             const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
-            return [this.buildMenuGroupParent(module, moduleItems)];
+            return [this.buildMenuGroupParent(module, moduleItems, { groupName })];
         }
         else {
             return moduleItems;
@@ -385,6 +397,7 @@ class AgGridMenuAdapter {
         ], {
             label: 'Export',
             icon: 'export',
+            groupName: 'export-group',
         }));
     }
     getLayoutContextMenuStructure(menuItems) {
@@ -402,14 +415,14 @@ class AgGridMenuAdapter {
         return [gridActionsItems, otherLayoutItems];
     }
     buildMenuGroupParent(module, menuItems, config) {
-        var _a, _b;
+        var _a, _b, _c;
         const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
         const icon = config && config.icon === false
             ? undefined
             : { name: (_a = config === null || config === void 0 ? void 0 : config.icon) !== null && _a !== void 0 ? _a : moduleInfo.Glyph };
         return {
-            name: 'menu-group',
-            label: (_b = config === null || config === void 0 ? void 0 : config.label) !== null && _b !== void 0 ? _b : moduleInfo.FriendlyName,
+            name: (_b = config === null || config === void 0 ? void 0 : config.groupName) !== null && _b !== void 0 ? _b : 'menu-group',
+            label: (_c = config === null || config === void 0 ? void 0 : config.label) !== null && _c !== void 0 ? _c : moduleInfo.FriendlyName,
             isVisible: true,
             module: moduleInfo.ModuleName,
             icon,
@@ -428,7 +441,7 @@ class AgGridMenuAdapter {
         // CustomSort
         const customSortMenuItems = this.getModuleSpecificStructure('CustomSort', availableMenuItems);
         // Dashboard
-        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems, 'dashboard-group');
         // DataImport
         const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
         // FlashingCell
@@ -455,8 +468,7 @@ class AgGridMenuAdapter {
         const gridMenuItem = {
             name: 'grid-group',
             label: 'Grid',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'grid',
@@ -474,8 +486,7 @@ class AgGridMenuAdapter {
         const columnMenuItem = {
             name: 'column-group',
             label: 'Column',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'columns',
@@ -493,8 +504,7 @@ class AgGridMenuAdapter {
         const createStyleMenuItem = {
             name: 'styling-group',
             label: 'Styling',
-            // TODO
-            module: 'ColumnInfo',
+            module: 'Group',
             isVisible: true,
             icon: {
                 name: 'brush',
@@ -553,26 +563,27 @@ class AgGridMenuAdapter {
         return styledColumnMenuItems;
     }
     mapAdaptableMenuItemToSystemMenuItems(adaptableMenuItems) {
-        return (adaptableMenuItems !== null && adaptableMenuItems !== void 0 ? adaptableMenuItems : []).map((menuItem) => {
+        if (!adaptableMenuItems) {
+            return;
+        }
+        return adaptableMenuItems.map((menuItem) => {
             if (menuItem === '-') {
                 return menuItem;
             }
-            let subItems = menuItem.subItems;
-            if (subItems && subItems.length > 0) {
-                subItems = subItems.map((subItem) => this.mapAdaptableMenuItemToSystemMenuItems(subItem.subItems));
-            }
+            // @ts-ignore
+            const subItems = this.mapAdaptableMenuItemToSystemMenuItems(menuItem.subItems);
             return Object.assign(Object.assign({}, menuItem), { menuType: 'Adaptable', subItems });
         });
     }
     createAdaptableColumnMenuItems(menuContext) {
-        let contextMenuItems = [];
+        let columnMenuItems = [];
         this.adaptableInstance.adaptableModules.forEach((s) => {
             let menuItems = s.createColumnMenuItems(menuContext.adaptableColumn);
             if (menuItems) {
-                contextMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
+                columnMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
             }
         });
-        return contextMenuItems;
+        return columnMenuItems;
     }
     // TODO AFL MIG: pretty sure this logic is duplicated in several other places
     mapAdaptableIconToAgGridIcon(adaptableIcon, style) {

package/src/env.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.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: 1712842436737 || Date.now(),
-    VERSION: "18.0.0-canary.33" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1712929490526 || Date.now(),
+    VERSION: "18.0.0-canary.35" || '--current-version--',
 };

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

@@ -357,6 +357,11 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    AdaptableColumnMenuItem: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AdaptableColumnPredicate: {
         name: string;
         kind: string;
@@ -413,6 +418,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         }[];
     };
+    AdaptableContextMenuItem: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AdaptableCoordinate: {
         name: string;
         kind: string;