Data.Aeson.Schema.Internal

Internal definitions for declaring JSON schemas.

Documentation

newtype Object (schema :: SchemaType)

The object containing JSON data and its schema.

Has a FromJSON instance, so you can use the usual Aeson decoding functions.

obj = decode "{\"a\": 1}" :: Maybe (Object [schema| { a: Int } |])

Constructors

UnsafeObject (HashMap Text Dynamic)

Instances

IsSchemaObject schema => Show (Object schema)

Defined in Data.Aeson.Schema.Internal

Methods

showsPrec :: Int -> Object schema -> ShowS

show :: Object schema -> String

showList :: [Object schema] -> ShowS

IsSchemaObject schema => FromJSON (Object schema)

Defined in Data.Aeson.Schema.Internal

Methods

parseJSON :: Value -> Parser (Object schema)

parseJSONList :: Value -> Parser [Object schema]

type IsSchemaObject schema = (IsSchemaType schema, SchemaResult schema ~ Object schema)

A constraint that checks if the given schema is a 'SchemaObject.

data SchemaType

The type-level schema definition for JSON data.

To view a schema for debugging, use showSchema.

Constructors

SchemaBool

SchemaInt

SchemaDouble

SchemaText

SchemaCustom Type

SchemaMaybe SchemaType

SchemaTry SchemaType

SchemaList SchemaType

SchemaObject [(SchemaKey, SchemaType)]

SchemaUnion [SchemaType]

@since v1.1.0

Instances

(KnownSchemaKey schemaKey, IsSchemaType inner, Show (SchemaResult inner), Typeable (SchemaResult inner), IsSchemaObject (SchemaObject rest), Typeable rest) => IsSchemaType (SchemaObject ((,) schemaKey inner ': rest))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject ((schemaKey, inner) ': rest)))

showValue :: SchemaResult (SchemaObject ((schemaKey, inner) ': rest)) -> String

IsSchemaType (SchemaObject ([] :: [(SchemaKey, SchemaType)]))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject []))

showValue :: SchemaResult (SchemaObject []) -> String

toSchemaTypeShow :: forall (a :: SchemaType). Typeable a => SchemaType

Convert SchemaType into SchemaType.

showSchema :: forall (a :: SchemaType). Typeable a => String

Pretty show the given SchemaType.

data SchemaKey

The type-level analogue of SchemaKey.

Constructors

NormalKey Symbol

PhantomKey Symbol

Instances

(KnownSchemaKey schemaKey, IsSchemaType inner, Show (SchemaResult inner), Typeable (SchemaResult inner), IsSchemaObject (SchemaObject rest), Typeable rest) => IsSchemaType (SchemaObject ((,) schemaKey inner ': rest))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject ((schemaKey, inner) ': rest)))

showValue :: SchemaResult (SchemaObject ((schemaKey, inner) ': rest)) -> String

IsSchemaType (SchemaObject ([] :: [(SchemaKey, SchemaType)]))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject []))

showValue :: SchemaResult (SchemaObject []) -> String

type family FromSchemaKey (schemaKey :: SchemaKey) where ...

Equations

FromSchemaKey (NormalKey key) = key

FromSchemaKey (PhantomKey key) = key

fromSchemaKey :: forall schemaKey. KnownSymbol (FromSchemaKey schemaKey) => Text

class (Typeable schemaKey, KnownSymbol (FromSchemaKey schemaKey)) => KnownSchemaKey (schemaKey :: SchemaKey) where

Methods

getContext :: HashMap Text Value -> Value

Instances

KnownSymbol key => KnownSchemaKey (NormalKey key)

Defined in Data.Aeson.Schema.Internal

Methods

getContext :: HashMap Text Value -> Value

KnownSymbol key => KnownSchemaKey (PhantomKey key)

Defined in Data.Aeson.Schema.Internal

Methods

getContext :: HashMap Text Value -> Value

type family SchemaResult (schema :: SchemaType) where ...

A type family mapping SchemaType to the corresponding Haskell type.

Equations

SchemaResult SchemaBool = Bool

SchemaResult SchemaInt = Int

SchemaResult SchemaDouble = Double

SchemaResult SchemaText = Text

SchemaResult (SchemaCustom inner) = inner

SchemaResult (SchemaMaybe inner) = Maybe (SchemaResult inner)

SchemaResult (SchemaTry inner) = Maybe (SchemaResult inner)

SchemaResult (SchemaList inner) = [SchemaResult inner]

SchemaResult (SchemaObject inner) = Object (SchemaObject inner)

SchemaResult (SchemaUnion schemas) = SumType (SchemaResultList schemas)

type family SchemaResultList (xs :: [SchemaType]) where ...

Equations

SchemaResultList '[] = '[]

SchemaResultList (x ': xs) = SchemaResult x ': SchemaResultList xs

class Typeable schema => IsSchemaType (schema :: SchemaType) where

A type-class for types that can be parsed from JSON for an associated schema type.

Minimal complete definition

Nothing

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult schema)

parseValue :: FromJSON (SchemaResult schema) => [Text] -> Value -> Parser (SchemaResult schema)

showValue :: SchemaResult schema -> String

showValue :: Show (SchemaResult schema) => SchemaResult schema -> String

Instances

IsSchemaType SchemaBool

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult SchemaBool)

showValue :: SchemaResult SchemaBool -> String

IsSchemaType SchemaInt

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult SchemaInt)

showValue :: SchemaResult SchemaInt -> String

IsSchemaType SchemaDouble

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult SchemaDouble)

showValue :: SchemaResult SchemaDouble -> String

IsSchemaType SchemaText

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult SchemaText)

showValue :: SchemaResult SchemaText -> String

(Show inner, Typeable inner, FromJSON inner) => IsSchemaType (SchemaCustom inner)

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaCustom inner))

showValue :: SchemaResult (SchemaCustom inner) -> String

(IsSchemaType inner, Show (SchemaResult inner)) => IsSchemaType (SchemaMaybe inner)

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaMaybe inner))

showValue :: SchemaResult (SchemaMaybe inner) -> String

(IsSchemaType inner, Show (SchemaResult inner)) => IsSchemaType (SchemaTry inner)

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaTry inner))

showValue :: SchemaResult (SchemaTry inner) -> String

(IsSchemaType inner, Show (SchemaResult inner)) => IsSchemaType (SchemaList inner)

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaList inner))

showValue :: SchemaResult (SchemaList inner) -> String

(KnownSchemaKey schemaKey, IsSchemaType inner, Show (SchemaResult inner), Typeable (SchemaResult inner), IsSchemaObject (SchemaObject rest), Typeable rest) => IsSchemaType (SchemaObject ((,) schemaKey inner ': rest))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject ((schemaKey, inner) ': rest)))

showValue :: SchemaResult (SchemaObject ((schemaKey, inner) ': rest)) -> String

IsSchemaType (SchemaObject ([] :: [(SchemaKey, SchemaType)]))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaObject []))

showValue :: SchemaResult (SchemaObject []) -> String

(All IsSchemaType schemas, Typeable schemas, Show (SchemaResult (SchemaUnion schemas)), FromJSON (SchemaResult (SchemaUnion schemas))) => IsSchemaType (SchemaUnion schemas)

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult (SchemaUnion schemas))

showValue :: SchemaResult (SchemaUnion schemas) -> String

parseFail :: forall (schema :: SchemaType) m a. (MonadFail m, Typeable schema) => [Text] -> Value -> m a

A helper for creating fail messages when parsing a schema.

data UnSchemaKey :: SchemaKey -> Exp Symbol

Instances

type Eval (UnSchemaKey (NormalKey key) :: Symbol -> Type)

Defined in Data.Aeson.Schema.Internal

type Eval (UnSchemaKey (NormalKey key) :: Symbol -> Type) = Eval (Pure key)

type Eval (UnSchemaKey (PhantomKey key) :: Symbol -> Type)

Defined in Data.Aeson.Schema.Internal

type Eval (UnSchemaKey (PhantomKey key) :: Symbol -> Type) = Eval (Pure key)

type Lookup a = Map Snd <=< Find (TyEq a <=< Fst)

type family LookupSchema (key :: Symbol) (schema :: SchemaType) :: SchemaType where ...

The type-level function that return the schema of the given key in a SchemaObject.

Equations

LookupSchema key (SchemaObject schema) = Eval (FromMaybe (TypeError (((Text "Key '" :<>: Text key) :<>: Text "' does not exist in the following schema:") :$$: ShowType schema)) =<< (Lookup key =<< Map (Bimap UnSchemaKey Pure) schema))

LookupSchema key schema = TypeError (((Text "Attempted to lookup key '" :<>: Text key) :<>: Text "' in the following schema:") :$$: ShowType schema)

getKey :: forall key schema endSchema result. (endSchema ~ LookupSchema key schema, result ~ SchemaResult endSchema, KnownSymbol key, Typeable result, Typeable endSchema) => Object schema -> result

Get a key from the given Object, returned as the type encoded in its schema.

let o = .. :: Object
            ( 'SchemaObject
               '[ '("foo", 'SchemaInt)
                , '("bar", 'SchemaObject
                     '[ '("name", 'SchemaText)
                      ]
                , '("baz", 'SchemaMaybe 'SchemaBool)
                ]
            )

getKey @"foo" o                  :: Bool
getKey @"bar" o                  :: Object ('SchemaObject '[ '("name", 'SchemaText) ])
getKey @"name" $ getKey @"bar" o :: Text
getKey @"baz" o                  :: Maybe Bool