supabase/apps/studio/components/layouts/DatabaseLayout/DatabaseMenu.utils.tsx

import { useParams } from 'common'
import { ArrowUpRight } from 'lucide-react'

import {
  useIsColumnLevelPrivilegesEnabled,
  useIsMarketplaceEnabled,
} from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext'
import { useIsETLPrivateAlpha } from '@/components/interfaces/Database/Replication/useIsETLPrivateAlpha'
import type {
  ProductMenuGroup,
  ProductMenuGroupItem,
} from '@/components/ui/ProductMenu/ProductMenu.types'
import { useDatabaseExtensionsQuery } from '@/data/database-extensions/database-extensions-query'
import { useProjectAddonsQuery } from '@/data/subscriptions/project-addons-query'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { IS_PLATFORM } from '@/lib/constants'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'

const ExternalLinkIcon = <ArrowUpRight strokeWidth={1} className="h-4 w-4" />

export const useGenerateDatabaseMenu = (): ProductMenuGroup[] => {
  const { ref } = useParams()
  const { data: project } = useSelectedProjectQuery()

  const {
    databaseReplication: showPgReplicate,
    databaseRoles: showRoles,
    integrationsWrappers: showWrappers,
  } = useIsFeatureEnabled(['database:replication', 'database:roles', 'integrations:wrappers'])

  const { data } = useDatabaseExtensionsQuery({
    projectRef: project?.ref,
    connectionString: project?.connectionString,
  })
  const { data: addons } = useProjectAddonsQuery({ projectRef: project?.ref })

  const pgNetExtensionExists = (data ?? []).some((ext) => ext.name === 'pg_net')
  const pitrEnabled = addons?.selected_addons.some((addon) => addon.type === 'pitr') ?? false
  const columnLevelPrivileges = useIsColumnLevelPrivilegesEnabled()
  const enablePgReplicate = useIsETLPrivateAlpha()

  const getDatabaseURL = (path: string) => `/project/${ref}/database/${path}`

  // In the new marketplace revamped page the `category=wrapper` query param has
  // changed to `type=wrapper`. So fix this link below based on which version is
  // the user viewing.
  const isMarketplaceEnabled = useIsMarketplaceEnabled()
  const wrappersLinkParamName = isMarketplaceEnabled ? 'type' : 'category'

  return [
    {
      title: 'Database Management',
      items: [
        {
          name: 'Schema Visualizer',
          key: 'schemas',
          url: getDatabaseURL('schemas'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_SCHEMA_VISUALIZER,
        },
        {
          name: 'Tables',
          key: 'tables',
          url: getDatabaseURL('tables'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_TABLES,
        },
        {
          name: 'Functions',
          key: 'functions',
          url: getDatabaseURL('functions'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_FUNCTIONS,
        },
        {
          name: 'Triggers',
          key: 'triggers',
          url: getDatabaseURL('triggers/data'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_TRIGGERS,
        },
        {
          name: 'Enumerated Types',
          key: 'types',
          url: getDatabaseURL('types'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_TYPES,
        },
        {
          name: 'Extensions',
          key: 'extensions',
          url: getDatabaseURL('extensions'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_EXTENSIONS,
        },
        {
          name: 'Indexes',
          key: 'indexes',
          url: getDatabaseURL('indexes'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_INDEXES,
        },
        {
          name: 'Publications',
          key: 'publications',
          url: getDatabaseURL('publications'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_PUBLICATIONS,
        },
      ],
    },
    {
      title: 'Configuration',
      items: [
        showRoles && {
          name: 'Roles',
          key: 'roles',
          url: getDatabaseURL('roles'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_ROLES,
        },
        columnLevelPrivileges && {
          name: 'Column Privileges',
          key: 'column-privileges',
          url: getDatabaseURL('column-privileges'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_COLUMN_PRIVILEGES,
        },
        {
          name: 'Policies',
          key: 'policies',
          url: `/project/${ref}/auth/policies`,
          rightIcon: ExternalLinkIcon,
        },
        {
          name: 'Settings',
          key: 'settings',
          url: getDatabaseURL('settings'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_SETTINGS,
        },
      ].filter(Boolean) as ProductMenuGroupItem[],
    },
    {
      title: 'Platform',
      items: [
        IS_PLATFORM &&
          showPgReplicate && {
            name: 'Replication',
            key: 'replication',
            url: getDatabaseURL('replication'),
            label: enablePgReplicate ? 'New' : undefined,
            shortcutId: SHORTCUT_IDS.NAV_DATABASE_REPLICATION,
          },
        IS_PLATFORM && {
          name: 'Backups',
          key: 'backups',
          url: pitrEnabled ? getDatabaseURL('backups/pitr') : getDatabaseURL('backups/scheduled'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_BACKUPS,
        },
        {
          name: 'Migrations',
          key: 'migrations',
          url: getDatabaseURL('migrations'),
          shortcutId: SHORTCUT_IDS.NAV_DATABASE_MIGRATIONS,
        },
        showWrappers && {
          name: 'Wrappers',
          key: 'wrappers',
          url: `/project/${ref}/integrations?${wrappersLinkParamName}=wrapper`,
          rightIcon: ExternalLinkIcon,
        },
        pgNetExtensionExists && {
          name: 'Database Webhooks',
          key: 'hooks',
          url: `/project/${ref}/integrations/webhooks/overview`,
          rightIcon: ExternalLinkIcon,
        },
      ].filter(Boolean) as ProductMenuGroupItem[],
    },
    {
      title: 'Tools',
      items: [
        {
          name: 'Security Advisor',
          key: 'security-advisor',
          url: `/project/${ref}/advisors/security`,
          rightIcon: ExternalLinkIcon,
        },
        {
          name: 'Performance Advisor',
          key: 'performance-advisor',
          url: `/project/${ref}/advisors/performance`,
          rightIcon: ExternalLinkIcon,
        },
        {
          name: 'Query Performance',
          key: 'query-performance',
          url: `/project/${ref}/observability/query-performance`,
          rightIcon: ExternalLinkIcon,
        },
      ],
    },
  ]
}