graphql-engine/server/src-lib/Hasura/Backends/DataWrapper/API/V0/OrderBy.hs

{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE OverloadedLists #-}

--
module Hasura.Backends.DataWrapper.API.V0.OrderBy
  ( OrderBy (..),
    OrderType (..),
  )
where

--------------------------------------------------------------------------------

import Autodocodec.Extended
import Autodocodec.OpenAPI ()
import Data.Aeson (FromJSON, ToJSON)
import Data.OpenApi (ToSchema)
import Hasura.Backends.DataWrapper.API.V0.Column qualified as API.V0
import Hasura.Incremental (Cacheable)
import Hasura.Prelude

--------------------------------------------------------------------------------

data OrderBy = OrderBy
  { column :: API.V0.ColumnName,
    ordering :: OrderType
  }
  deriving stock (Data, Eq, Generic, Ord, Show)
  deriving anyclass (Cacheable, Hashable, NFData)
  deriving (FromJSON, ToJSON, ToSchema) via Autodocodec OrderBy

instance HasCodec OrderBy where
  codec =
    object "OrderBy" $
      OrderBy
        <$> requiredField "column" "Column to order by" .= column
        <*> requiredField "ordering" "Ordering" .= ordering

--------------------------------------------------------------------------------

data OrderType
  = Ascending
  | Descending
  deriving stock (Data, Eq, Generic, Ord, Show, Enum, Bounded)
  deriving anyclass (Cacheable, Hashable, NFData)
  deriving (FromJSON, ToJSON, ToSchema) via Autodocodec OrderType

instance HasCodec OrderType where
  codec =
    named "OrderType" $
      disjointStringConstCodec [(Ascending, "asc"), (Descending, "desc")]