feat: enhance menu configuration and visibility options

- Added support for JSON files in the .gitignore to improve configuration management.
- Updated the `useMenu` composable to include a new `useDefaultEntries` option for menu entries, allowing for better control over default menu visibility.
- Introduced `hideInDashboard` property in `MenuItem` type to manage item visibility in the dashboard.
- Enhanced the menu rendering logic to filter out items marked as hidden in the dashboard, improving user experience.

Author: tacxou

apps/web/config/.gitignore

@@ -1 +1,2 @@
 *.yml
+*.json

apps/web/src/composables/useMenu.ts

@@ -1,13 +1,11 @@
 import type { BadgeItem, MenuItem } from '~/constants/types'
-import { useIdentityStates } from './useIdentityStates'
-import { DefaultMenuParts, MaxMenuBadgeCount, MenuPart } from '~/constants/variables'
-import { IdentityState } from '~/constants/enums'
+import { DefaultMenuParts, MaxMenuBadgeCount } from '~/constants/variables'
 import qs from 'qs'
 import type { useIdentityStateStore } from '~/stores/identityState'
+import { getDefaultMenuEntries } from '~/constants/defaultMenuEntries'
 import { sort } from 'radash'
 
-const { getStateBadge } = useIdentityStates()
-const config = useAppConfig()
+const config = useAppConfig() as any
 
 type useMenuReturnType = {
   getMenu: () => MenuItem[]
@@ -23,225 +21,122 @@ type MenuPartItem = {
 
 function useMenu(identityStateStore: ReturnType<typeof useIdentityStateStore>): useMenuReturnType {
   const menuParts = ref<MenuPartItem[]>(DefaultMenuParts)
+  const useDefaultEntries = config?.menus?.useDefaultEntries !== false
   const menuEntries = (config?.menus?.entries as any[]) || []
   const { hasPermission, hasPermissionStartsWith } = useAccessControl()
 
-  if (config?.menus?.parts) {
-    menuParts.value = sort([...menuParts.value, ...(config.menus?.parts as any) || []], (part) => {
-      const pos = part.position || 9_999
-      return pos
-    })
+  function normalizeNameFromLabel(label: string): string {
+    // Auto-remplissage côté déploiement :
+    // - minuscules
+    // - espaces -> `_`
+    // - le reste est conservé tel quel
+    return label.toLowerCase().trim().replace(/\s+/g, '_')
   }
 
-  const menus = ref<MenuItem[]>([
-    {
-      icon: 'mdi-account',
-      label: 'Liste des identités',
-      path: '/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0',
-      color: 'primary',
-      badge: { color: 'primary' },
-      part: MenuPart.DONNEES,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-download-outline',
-      label: 'Exporter',
-      path: '/identities/export',
-      color: 'accent',
-      part: MenuPart.DONNEES,
-      hideInMenuBar: true,
-      _acl: '/management/identities',
-    }, {
-      icon: 'mdi-book-clock',
-      label: 'Journal des jobs',
-      path: '/jobs/table?filters[:state]=-1',
-      color: 'info',
-      part: MenuPart.DONNEES,
-      hideInMenuBar: false,
-      _acl: '/core/jobs',
-    }, {
-      icon: 'mdi-timeline-clock-outline',
-      label: 'Cycle de vie des identités',
-      path: '/lifecycles/table',
-      color: 'info',
-      part: MenuPart.DONNEES,
-      hideInMenuBar: false,
-      _acl: '/management/lifecycle',
-    },
-    {
-      icon: 'mdi-clipboard-text-clock',
-      label: 'Historique des changements',
-      path: '/audits/table',
-      color: 'lime-8',
-      hideInMenuBar: false,
-      part: MenuPart.DONNEES,
-      _acl: '/core/audits',
-    },
-    {
-      icon: 'mdi-set-merge',
-      label: 'Detection des doublons',
-      path: '/identities/fusion',
-      color: 'positive',
-      part: MenuPart.DONNEES,
-      hideInMenuBar: true,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-trash-can',
-      label: 'Corbeille',
-      path: '/identities/trash',
-      color: 'grey-10',
-      hideInMenuBar: true,
-      part: MenuPart.DONNEES,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-account-check',
-      label: 'A valider',
-      path: `/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[#state]=${IdentityState.TO_VALIDATE}`,
-      color: 'warning',
-      textColor: 'black',
-      badge: getStateBadge(IdentityState.TO_VALIDATE),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-account-alert',
-      label: 'A compléter',
-      path: `/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.TO_COMPLETE}`,
-      color: 'secondary',
-      textColor: 'black',
-      badge: getStateBadge(IdentityState.TO_COMPLETE),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-sync',
-      label: 'A synchroniser',
-      path: `/identities/table?readonly=1&sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.TO_SYNC}`,
-      color: 'orange-8',
-      badge: getStateBadge(IdentityState.TO_SYNC),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-loading',
-      label: 'En cours de synchro.',
-      path: `/identities/table?readonly=1&sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.PROCESSING}`,
-      color: 'grey-8',
-      badge: getStateBadge(IdentityState.PROCESSING),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-check',
-      label: 'Synchronisées',
-      path: `/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.SYNCED}`,
-      badge: getStateBadge(IdentityState.SYNCED),
-      color: 'positive',
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-account-switch-outline',
-      label: 'Fusionnées',
-      path: '/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[~primaryEmployeeNumber]=true',
-      color: 'linear-gradient(135deg, #7C3AED 0%, #EC4899 50%, #F97316 100%)',
-      textColor: 'white',
-      badge: { color: 'linear-gradient(135deg, #7C3AED 0%, #EC4899 50%, #F97316 100%)', textColor: 'white' },
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    ...menuEntries
-      .filter((entry: any) => {
-        if (entry._acl) {
-          return hasPermissionStartsWith([entry._acl])
+  if (config?.menus?.parts) {
+    const overrideParts = config.menus.parts as any[]
+    const mergedParts: MenuPartItem[] = [...menuParts.value]
+
+    for (const overridePart of overrideParts) {
+      const overrideLabel = typeof overridePart?.label === 'string' ? overridePart.label : ''
+      if (!overrideLabel) continue
+
+      const matchIndex = mergedParts.findIndex((part) => part.label === overrideLabel)
+      if (matchIndex >= 0) {
+        mergedParts[matchIndex] = {
+          ...mergedParts[matchIndex],
+          ...(overridePart as any),
         }
+      } else {
+        mergedParts.push(overridePart as any)
+      }
+    }
+
+    menuParts.value = sort(mergedParts, (part) => part.position || 9_999)
+  }
+
+  const defaultMenuEntries = getDefaultMenuEntries()
+
+  // Fusion des menus : les entrées YAML peuvent surcharger (override) les entrées par défaut.
+  // Override :
+  // - priorité au match par `path` (exact)
+  // - sinon match par `name` (fourni ou dérivé du `label`)
+  // - sinon match par `label` (normalisé, pour compat)
+  // - si aucune entrée ne correspond : ajout (placé avant "En erreur" si possible)
+  const baseMenuEntries = useDefaultEntries ? defaultMenuEntries : []
+  const insertionIndex = baseMenuEntries.findIndex((m) => m.label === 'En erreur')
+
+  const mergedMenuEntries: MenuItem[] = [...baseMenuEntries]
+  const unmatchedOverrides: MenuItem[] = []
+
+  for (const overrideEntry of menuEntries as any[]) {
+    const overridePath = typeof overrideEntry?.path === 'string' ? overrideEntry.path.trim() : ''
+    const overrideLabel = typeof overrideEntry?.label === 'string' ? overrideEntry.label : ''
+    const overrideName =
+      typeof overrideEntry?.name === 'string'
+        ? normalizeNameFromLabel(overrideEntry.name)
+        : overrideLabel
+          ? normalizeNameFromLabel(overrideLabel)
+          : ''
+
+    const matchIndexByPath = overridePath ? mergedMenuEntries.findIndex((m) => m.path === overridePath) : -1
+    const matchIndexByName =
+      matchIndexByPath === -1 && overrideName
+        ? mergedMenuEntries.findIndex((m) => typeof m.name === 'string' && normalizeNameFromLabel(m.name) === overrideName)
+        : -1
+
+    const matchIndexByLabel =
+      matchIndexByPath === -1 && matchIndexByName === -1 && !overrideName && overrideLabel
+        ? mergedMenuEntries.findIndex((m) => normalizeLabel(m.label) === normalizeLabel(overrideLabel))
+        : -1
+
+    const matchIndex = matchIndexByPath >= 0 ? matchIndexByPath : matchIndexByName >= 0 ? matchIndexByName : matchIndexByLabel
+
+    if (matchIndex >= 0) {
+      mergedMenuEntries[matchIndex] = {
+        ...mergedMenuEntries[matchIndex],
+        ...(overrideEntry as any),
+      }
+    } else {
+      unmatchedOverrides.push(overrideEntry as any)
+    }
+  }
+
+  if (unmatchedOverrides.length > 0) {
+    const indexToInsert = insertionIndex >= 0 ? insertionIndex : mergedMenuEntries.length
+    mergedMenuEntries.splice(indexToInsert, 0, ...unmatchedOverrides)
+  }
+
+  // `name` est optionnel dans `menus.yml`. On l'auto-remplit sinon.
+  for (let i = 0; i < mergedMenuEntries.length; i++) {
+    const entry = mergedMenuEntries[i]
+    if (typeof (entry as any)?.name === 'string' && (entry as any).name.trim()) continue
+    if (typeof entry.label !== 'string' || !entry.label.trim()) continue
+    ;(mergedMenuEntries[i] as any).name = normalizeNameFromLabel(entry.label)
+  }
+
+  const menus = ref<MenuItem[]>(
+    mergedMenuEntries.filter((entry) => {
+      // Si `_acl` est fourni, on laisse `getMenu()` gérer l'autorisation exacte.
+      if (entry._acl) return true
+      if (!entry.path) return false
+
+      const basePath = entry.path.replace(/^\//, '')
+      const pathWithoutQuery = basePath.split('?')[0] || ''
+      const uri = pathWithoutQuery.split('/')[0] || ''
 
-        const basePath = entry.path.replace(/^\//, '')
-        const path = basePath.split('?')[0] || ''
-        const uri = path[0].split('/')[0] || ''
-
-        return hasPermissionStartsWith([uri])
-      }) || [],
-    {
-      icon: 'mdi-account-remove',
-      label: 'En erreur',
-      path: `/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.ON_ERROR}`,
-      color: 'negative',
-      badge: getStateBadge(IdentityState.ON_ERROR),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-publish-off',
-      label: 'À ne pas synchroniser',
-      path: `/identities/table?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[%23state]=${IdentityState.DONT_SYNC}`,
-      color: 'black',
-      badge: getStateBadge(IdentityState.DONT_SYNC),
-      part: MenuPart.ETATS,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-email-alert',
-      label: 'Invitations non envoyées',
-      path: '/identities/table?limit=10&skip=0&filters[%23initState]=0&sort[metadata.lastUpdatedAt]=desc',
-      color: 'negative',
-      part: MenuPart.ACTIVATION,
-      badge: { color: 'negative' },
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-email-fast',
-      label: 'Invitations envoyées',
-      path: '/identities/table?limit=10&skip=0&filters[%23initState]=1&sort[metadata.lastUpdatedAt]=desc',
-      color: 'warning',
-      textColor: 'black',
-      part: MenuPart.ACTIVATION,
-      badge: { color: 'warning', textColor: 'black' },
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-email-open',
-      label: 'Comptes activés',
-      path: '/identities/table?limit=10&skip=0&filters[%23initState]=2&sort[metadata.lastUpdatedAt]=desc',
-      color: 'positive',
-      textColor: 'white',
-      part: MenuPart.ACTIVATION,
-      badge: { color: 'positive' },
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-    {
-      icon: 'mdi-email-remove',
-      label: 'Invitations périmées',
-      path: '/identities/outdated',
-      color: 'accent',
-      part: MenuPart.ACTIVATION,
-      hideInMenuBar: false,
-      _acl: '/management/identities',
-    },
-  ])
+      return uri ? hasPermissionStartsWith([uri]) : false
+    }),
+  )
 
   function normalizeLabel(label: string): string {
     return label.toLowerCase().normalize("NFD").replace(/[\u0300-\u036f]/g, '').replace(/ /g, '_').replace(/\./g, '')
   }
 
   function getMenu(): MenuItem[] {
     const menuList: MenuItem[] = menus.value.reduce((acc: MenuItem[], menu) => {
-      const label = normalizeLabel(menu.label)
-      const stateValue = identityStateStore.getStateValue(label)
+      const stateKey = typeof menu.name === 'string' && menu.name.trim() ? menu.name : normalizeLabel(menu.label)
+      const stateValue = identityStateStore.getStateValue(stateKey)
       const value = stateValue > MaxMenuBadgeCount ? MaxMenuBadgeCount + '+' : stateValue?.toString() || '0'
 
       if (menu._acl && !hasPermission(menu._acl, AccessControlAction.READ, AccessControlPossession.ANY)) {
@@ -272,7 +167,7 @@ function useMenu(identityStateStore: ReturnType<typeof useIdentityStateStore>):
     const filters = {}
     for (const menu of menus.value) {
       if (menu.path && menu.badge) {
-        const label = normalizeLabel(menu.label)
+        const stateKey = typeof menu.name === 'string' && menu.name.trim() ? menu.name : normalizeLabel(menu.label)
         const params = new URL(window.location.origin + encodePath(menu.path)).searchParams
         const queryString = qs.parse(params.toString())
         const qsFilters = {}
@@ -281,7 +176,7 @@ function useMenu(identityStateStore: ReturnType<typeof useIdentityStateStore>):
           qsFilters[decodeURIComponent(key)] = decodeURIComponent(value as string)
         }
 
-        filters[label] = qsFilters
+        filters[stateKey] = qsFilters
       }
     }