content: {-# LANGUAGE GeneralizedNewtypeDeriving #-}
  
  -- This file is part of the Wire Server implementation.
  --
  -- Copyright (C) 2022 Wire Swiss GmbH <opensource@wire.com>
  --
  -- This program is free software: you can redistribute it and/or modify it under
  -- the terms of the GNU Affero General Public License as published by the Free
  -- Software Foundation, either version 3 of the License, or (at your option) any
  -- later version.
  --
  -- This program is distributed in the hope that it will be useful, but WITHOUT
  -- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  -- FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
  -- details.
  --
  -- You should have received a copy of the GNU Affero General Public License along
  -- with this program. If not, see <https://www.gnu.org/licenses/>.
  
  module Wire.API.Team.SearchVisibility
    ( TeamSearchVisibility (..),
      TeamSearchVisibilityView (..),
    )
  where
  
  import Control.Lens ((?~))
  import Data.OpenApi qualified as S
  import Data.Schema
  import Deriving.Aeson
  import Imports
  import Wire.Arbitrary (Arbitrary, GenericUniform (..))
  
  --------------------------------------------------------------------------------
  -- TeamSearchVisibility
  
  -- | Who can find whom inside and outside of a team?
  -- Individual setting for one team, chosen by the admin.
  --
  -- @
  -- Standard:
  --   Outbound:
  --     Handle: can find anyone
  --     Name: same team or non team users
  --   Inbound:
  --     Handle: can be found by anyone
  --     Name: can be found by same team only
  -- NoNameOutsideTeam:
  --   Outbound:
  --     Handle: can find anyone
  --     Name: same team only
  --   Inbound:
  --     Handle: can be found by anyone
  --     Name: can be found by same team only
  -- @
  --
  -- See also: 'FeatureTeamSearchVisibilityAvailability'.
  data TeamSearchVisibility
    = SearchVisibilityStandard
    | SearchVisibilityNoNameOutsideTeam
    deriving stock (Eq, Show, Ord, Enum, Bounded, Generic)
    deriving (Arbitrary) via (GenericUniform TeamSearchVisibility)
    deriving (ToJSON, FromJSON, S.ToSchema) via (Schema TeamSearchVisibility)
  
  instance ToSchema TeamSearchVisibility where
    schema =
      enum @Text
        "TeamSearchVisibility"
        $ mconcat
          [ element "standard" SearchVisibilityStandard,
            element "no-name-outside-team" SearchVisibilityNoNameOutsideTeam
          ]
  
  --------------------------------------------------------------------------------
  -- TeamSearchVisibilityView
  
  newtype TeamSearchVisibilityView = TeamSearchVisibilityView TeamSearchVisibility
    deriving stock (Eq, Show, Ord, Bounded, Generic)
    deriving newtype (Arbitrary)
    deriving (ToJSON, FromJSON, S.ToSchema) via (Schema TeamSearchVisibilityView)
  
  instance ToSchema TeamSearchVisibilityView where
    schema =
      objectWithDocModifier "TeamSearchVisibilityView" (description ?~ "Search visibility value for the team") $
        TeamSearchVisibilityView
          <$> unwrap .= fieldWithDocModifier "search_visibility" (description ?~ "value of visibility") schema
      where
        unwrap (TeamSearchVisibilityView v) = v
  