mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-16 18:42:30 +03:00
332faabc24
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6062 GitOrigin-RevId: f1ba9fa30267d1825ba36480103cd973616f3079
60 lines
2.1 KiB
Haskell
60 lines
2.1 KiB
Haskell
-- | Utility functions for use defining autodocodec codecs.
|
|
module Hasura.Metadata.DTO.Utils
|
|
( codecNamePrefix,
|
|
fromEnvCodec,
|
|
versionField,
|
|
optionalVersionField,
|
|
)
|
|
where
|
|
|
|
import Autodocodec
|
|
( Codec (EqCodec),
|
|
JSONCodec,
|
|
ObjectCodec,
|
|
object,
|
|
optionalFieldWith',
|
|
requiredField',
|
|
requiredFieldWith',
|
|
scientificCodec,
|
|
(.=),
|
|
)
|
|
import Data.Scientific (Scientific)
|
|
import Data.Text qualified as T
|
|
import Data.Text.Extended qualified as T
|
|
import Hasura.Prelude
|
|
import Hasura.SQL.Tag (HasTag (backendTag), reify)
|
|
|
|
-- | Defines a required object field named @version@ that must have the given
|
|
-- integer value. On serialization the field will have the given value
|
|
-- automatically. On deserialization parsing will fail unless the field has the
|
|
-- exact given value.
|
|
versionField :: Integer -> ObjectCodec a Scientific
|
|
versionField v = requiredFieldWith' "version" (EqCodec n scientificCodec) .= const n
|
|
where
|
|
n = fromInteger v
|
|
|
|
-- | Defines an optional object field named @version@ that must have the given
|
|
-- integer value if the field is present. On serialization the field will have
|
|
-- the given value automatically. On deserialization parsing will fail unless
|
|
-- the field has the exact given value, or is absent.
|
|
optionalVersionField :: Integer -> ObjectCodec a (Maybe Scientific)
|
|
optionalVersionField v =
|
|
optionalFieldWith' "version" (EqCodec n scientificCodec) .= const (Just n)
|
|
where
|
|
n = fromInteger v
|
|
|
|
-- | Provides a title-cased name for a database kind, inferring the appropriate
|
|
-- database kind from type context.
|
|
codecNamePrefix :: forall b. (HasTag b) => Text
|
|
codecNamePrefix = T.toTitle $ T.toTxt $ reify $ backendTag @b
|
|
|
|
-- | Represents a text field wrapped in an object with a single property
|
|
-- named @from_env@.
|
|
--
|
|
-- Objects of this form appear in many places in the Metadata API. If we
|
|
-- reproduced this codec in each use case the OpenAPI document would have many
|
|
-- identical object definitions. Using a shared codec allows a single shared
|
|
-- reference.
|
|
fromEnvCodec :: JSONCodec Text
|
|
fromEnvCodec = object "FromEnv" $ requiredField' "from_env"
|