chore: dynamically activate menu options when file is opened

Signed-off-by: alexzurbonsen <alexander.zur.bonsen@tngtech.com>

Author: alexzurbonsen

src/ElectronBackend/main/listeners.ts

@@ -46,7 +46,7 @@ import {
   setGlobalBackendState,
 } from './globalBackendState';
 import logger from './logger';
-import {activateMenuOptions} from "./menu";
+import { activateMenuOptions } from './menu';
 
 const outputFileEnding = '_attributions.json';
 const jsonGzipFileExtension = '.json.gz';

src/ElectronBackend/main/menu.ts

@@ -25,33 +25,66 @@ import {
 } from './notice-document-helpers';
 import { UserSettings } from './user-settings';
 
-// type Item = {label: string, id: string}
+const INITIALLY_DISABLED_MENU_ITEMS = [
+  'save',
+  'projectMetadata',
+  'projectStatistics',
+  'followUp',
+  'compactComponentList',
+  'detailedComponentList',
+  'spdxYAML',
+  'spdxJSON',
+  'selectAll',
+  'searchAttributions',
+  'searchSignals',
+  'searchResourcesAll',
+  'searchResourceLinked',
+] as const;
 
-const MENU_ITEMS = {
-  file: {label: 'File', id: 'file'},
-  open: {label: 'Open File', id: 'open'},
-  save: {label: 'Save', id: 'save'},
-  export: {label: 'Export', id: 'export'},
-  followUp: {label: 'Follow-Up', id: 'follow-up'},
-  compactComponentList: {label: 'Compact component list', id: 'compact-list'},
-  detailedComponentList: {label: 'Detailed component list', id: 'detailed-list'},
-  spdxYAML: {label: 'SPDX (yaml)', id: 'spdx-yaml'},
-  spdxJSON: {label: 'SPDX (json)', id: 'spdx-json'},
-  projectMetadata: {label: 'Project Metadata', id: 'project-metadata'},
-  projectStatistics: {label: 'Project Statistics', id: 'project-statistics'},
-  pathToSources: {label: 'Set Path to Sources', id: 'path-to-sources'},
-  quit: {label: 'Quit', id: 'quit'},
-}
+type Item = { label: string; id: string };
 
-const INITIALLY_DISABLED_MENU_ITEM_IDS: Array<string> = [MENU_ITEMS.save.id, MENU_ITEMS.export.id, MENU_ITEMS.projectMetadata.id, MENU_ITEMS.projectStatistics.id]
+const MENU_ITEMS: Record<(typeof INITIALLY_DISABLED_MENU_ITEMS)[number], Item> =
+  {
+    save: { label: 'Save', id: 'save' },
+    followUp: { label: 'Follow-Up', id: 'follow-up' },
+    compactComponentList: {
+      label: 'Compact component list',
+      id: 'compact-list',
+    },
+    detailedComponentList: {
+      label: 'Detailed component list',
+      id: 'detailed-list',
+    },
+    spdxYAML: { label: 'SPDX (yaml)', id: 'spdx-yaml' },
+    spdxJSON: { label: 'SPDX (json)', id: 'spdx-json' },
+    projectMetadata: { label: 'Project Metadata', id: 'project-metadata' },
+    projectStatistics: {
+      label: 'Project Statistics',
+      id: 'project-statistics',
+    },
+    selectAll: { label: 'Select All', id: 'select-all' },
+    searchAttributions: {
+      label: 'Search Attributions',
+      id: 'search-attributions',
+    },
+    searchSignals: { label: 'Search Signals', id: 'search-signals' },
+    searchResourcesAll: {
+      label: 'Search All Resources',
+      id: 'search-resources-all',
+    },
+    searchResourceLinked: {
+      label: 'Search Linked Resources',
+      id: 'search-resources-linked',
+    },
+  };
 
 export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
   const webContents = mainWindow.webContents;
   const qaMode = await UserSettings.get('qaMode');
 
   return Menu.buildFromTemplate([
     {
-      label: MENU_ITEMS.file.label,
+      label: 'File',
       submenu: [
         {
           icon: getIconBasedOnTheme(
@@ -80,13 +113,11 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
           enabled: false,
         },
         {
-          label: MENU_ITEMS.export.label,
+          label: 'Export',
           icon: getIconBasedOnTheme(
             'icons/export-white.png',
             'icons/export-black.png',
           ),
-          id: MENU_ITEMS.export.id,
-          enabled: false,
           submenu: [
             {
               label: MENU_ITEMS.followUp.label,
@@ -102,6 +133,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.FollowUp,
                 );
               },
+              id: MENU_ITEMS.followUp.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
@@ -117,7 +150,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.CompactBom,
                 );
               },
-
+              id: MENU_ITEMS.compactComponentList.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
@@ -135,6 +169,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.DetailedBom,
                 );
               },
+              id: MENU_ITEMS.detailedComponentList.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
@@ -150,6 +186,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.SpdxDocumentYaml,
                 );
               },
+              id: MENU_ITEMS.spdxYAML.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
@@ -165,6 +203,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.SpdxDocumentJson,
                 );
               },
+              id: MENU_ITEMS.spdxJSON.id,
+              enabled: false,
             },
           ],
         },
@@ -211,7 +251,7 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/restore-white.png',
             'icons/restore-black.png',
           ),
-          label: MENU_ITEMS.pathToSources.label,
+          label: 'Set Path to Sources',
           click: () => {
             getSelectBaseURLListener(mainWindow)();
           },
@@ -221,7 +261,7 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/quit-white.png',
             'icons/quit-black.png',
           ),
-          label: MENU_ITEMS.quit.label,
+          label: 'Quit',
           accelerator: 'CmdOrCtrl+Q',
           click: () => {
             app.quit();
@@ -283,62 +323,72 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/select-all-white.png',
             'icons/select-all-black.png',
           ),
-          label: 'Select All',
+          label: MENU_ITEMS.selectAll.label,
           accelerator: 'CmdOrCtrl+A',
           role: 'selectAll',
+          id: MENU_ITEMS.selectAll.id,
+          enabled: false,
         },
         { type: 'separator' },
         {
           icon: getIconBasedOnTheme(
             'icons/magnifying-glass-white.png',
             'icons/magnifying-glass-black.png',
           ),
-          label: 'Search Attributions',
+          label: MENU_ITEMS.searchAttributions.label,
           accelerator: 'CmdOrCtrl+Shift+A',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchAttributions);
             }
           },
+          id: MENU_ITEMS.searchAttributions.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/magnifying-glass-white.png',
             'icons/magnifying-glass-black.png',
           ),
-          label: 'Search Signals',
+          label: MENU_ITEMS.searchSignals.label,
           accelerator: 'CmdOrCtrl+Shift+S',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchSignals);
             }
           },
+          id: MENU_ITEMS.searchSignals.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/search-white.png',
             'icons/search-black.png',
           ),
-          label: 'Search All Resources',
+          label: MENU_ITEMS.searchResourcesAll.label,
           accelerator: 'CmdOrCtrl+Shift+R',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchResources);
             }
           },
+          id: MENU_ITEMS.searchResourcesAll.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/search-white.png',
             'icons/search-black.png',
           ),
-          label: 'Search Linked Resources',
+          label: MENU_ITEMS.searchResourceLinked.label,
           accelerator: 'CmdOrCtrl+Shift+L',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchLinkedResources);
             }
           },
+          id: MENU_ITEMS.searchResourceLinked.id,
+          enabled: false,
         },
       ],
     },
@@ -482,17 +532,10 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
 
 export function activateMenuOptions(): void {
   const menu = Menu.getApplicationMenu();
-  // INITIALLY_DISABLED_MENU_ITEM_IDS.forEach((id) => {
-  //   console.log("key: ", id)
-  //   const item = menu?.getMenuItemById(id)
-  //   if (item) {
-  //     console.log("enable: ", item.label)
-  //     item.enabled = true;
-  //   }
-  // })
-  const save = menu?.getMenuItemById(MENU_ITEMS['save'].id)
-  if (save) {
-    console.log("heeereeeee");
-    save.enabled = true;
-  }
+  INITIALLY_DISABLED_MENU_ITEMS.forEach((key) => {
+    const menuItem = menu?.getMenuItemById(MENU_ITEMS[key].id);
+    if (menuItem) {
+      menuItem.enabled = true;
+    }
+  });
 }