REC_Notify

  ---@class REC_Notify.Shared.Config
  local config = {}

  ---[[
  ---    Debug Mode
  ---]]
  ---@type boolean
  config.debugMode = true

  ---[[
  ---     Look and behaviour of the notifications
  ---]]
  config.ui = {

      ---[[
      ---     Default position (each notification can override it with payload.position)
      ---]]
      ---@type REC_Notify.Shared.Enum.Position
      position = "top-right",

      ---[[
      ---     Maximum number shown at once
      ---     Anything over the limit waits in a queue until an older notification is gone
      ---]]
      ---@type integer
      maxVisible = 5,

      ---[[
      ---     Stack new notifications on top (false stacks them below)
      ---]]
      ---@type boolean
      newestOnTop = true,

      ---[[
      ---     Card width and the distance from the screen edge (CSS units)
      ---]]
      ---@type string
      width = "330px",
      offset = {
          ---@type string
          x = "1.6vw",
          ---@type string
          y = "3vh",
      },
      ---@type string
      gap = "10px",

      ---[[
      ---     Display time used when duration is omitted
      ---]]
      ---@type integer
      defaultDuration = 5000, -- ms

      ---[[
      ---     Enter and exit animation time
      ---]]
      ---@type integer
      animationDuration = 260, -- ms

      ---[[
      ---     Show the remaining time progress bar
      ---]]
      ---@type boolean
      showProgress = true,

      ---[[
      ---     Show the icon
      ---]]
      ---@type boolean
      showIcon = true,

      ---[[
      ---     Font size multiplier (1.0 is the default)
      ---     Applied to a 14.5px title and a 14px body
      ---]]
      ---@type number
      fontScale = 1.0,
  }

  ---[[
  ---     Colour, icon and sound per notification type
  ---     icon takes an icon from shared/sh_enum.lua or a custom SVG path ("path:M12 2L...")
  ---     file:     an audio file in web/build/sounds/ (in development put it in web/public/sounds/ and run pnpm build)
  ---     frontend: a built-in GTA sound (used when mode = "frontend")
  ---     volume:   to change the volume for this type only (nil falls back to config.sound.volume)
  ---     set sound to nil to make this type silent
  ---]]
  ---@type table<REC_Notify.Shared.Enum.NotifyType, REC_Notify.Shared.Config.Type>
  config.types = {
      success = {
          color = "#4ade80",
          icon = "check",
          sound = {
              file = "success.wav",
              frontend = { set = "HUD_FRONTEND_DEFAULT_SOUNDSET", name = "SELECT", },
              volume = nil,
          },
      },
      error = {
          color = "#f87171",
          icon = "xmark",
          sound = {
              file = "error.wav",
              frontend = { set = "HUD_FRONTEND_DEFAULT_SOUNDSET", name = "CANCEL", },
              volume = nil,
          },
      },
      info = {
          color = "#60a5fa",
          icon = "info",
          sound = {
              file = "info.wav",
              frontend = { set = "HUD_FRONTEND_DEFAULT_SOUNDSET", name = "NAV_UP_DOWN", },
              volume = nil,
          },
      },
      warning = {
          color = "#fbbf24",
          icon = "warning",
          sound = {
              file = "warning.wav",
              frontend = { set = "HUD_FRONTEND_DEFAULT_SOUNDSET", name = "FOCUSIN", },
              volume = nil,
          },
      },
      neutral = {
          color = "#cbd5e1",
          icon = "bell",
          sound = {
              file = "neutral.wav",
              frontend = { set = "HUD_FRONTEND_DEFAULT_SOUNDSET", name = "NAV_UP_DOWN", },
              volume = nil,
          },
      },
  }

  ---[[
  ---     Sound settings
  ---     enabled = false silences every notification (it wins over the caller's playSound)
  ---]]
  config.sound = {

      ---@type boolean
      enabled = true,

      ---[[
      ---     Default used when the caller omits playSound
      ---]]
      ---@type boolean
      default = true,

      ---[[
      ---     How to play it
      ---     "nui":      plays an audio file from web/build/sounds/ through NUI (the volume can be changed)
      ---     "frontend": plays a built-in GTA sound (no extra files needed)
      ---]]
      ---@type REC_Notify.Shared.Enum.SoundMode
      mode = "nui",

      ---[[
      ---     Volume (0.0 to 1.0)
      ---     Only used when mode = "nui"
      ---]]
      ---@type number
      volume = 0.4,
  }

  return config

  ---@class REC_Notify.Shared.Config.Type
  ---@field color string
  ---@field icon string
  ---@field sound REC_Notify.Shared.Config.Sound|nil
  ---@

  ---@class REC_Notify.Shared.Config.Sound
  ---@field file string|nil
  ---@field frontend REC_Notify.Shared.Config.Sound.Frontend|nil
  ---@field volume number|nil
  ---@

  ---@class REC_Notify.Shared.Config.Sound.Frontend
  ---@field set string
  ---@field name string