Safe Haskell	None
Language	Haskell2010

Schemas.Untyped

Synopsis

newtype SchemaName = SchemaName String
data Schema
- = Array Schema
- | StringMap Schema
- | Enum (NonEmpty Text)
- | Record (HashMap Text Field)
- | OneOf (NonEmpty Schema)
- | Prim Text
- | Named SchemaName Schema
- | Empty
data Field = Field {
- fieldSchema :: Schema
- isRequired :: Bool
}
fieldSchemaL :: Applicative f => (Schema -> f Schema) -> Field -> f Field
pattern Unit :: Schema
pattern Union :: NonEmpty (Text, Schema) -> Schema
_Unit :: Prism' Schema ()
_Union :: Prism' Schema (NonEmpty (Text, Schema))
type Trace = [Text]
data Mismatch
- = MissingRecordField {
  - name :: Text
  }
- | MissingEnumChoices {
  - choices :: NonEmpty Text
  }
- | OptionalRecordField {
  - name :: Text
  }
- | InvalidRecordField {
  - name :: Text
  }
- | InvalidEnumValue {
  - given :: Text
  - options :: NonEmpty Text
  }
- | InvalidRecordValue {
  - value :: Value
  }
- | InvalidConstructor {
  - name :: Text
  }
- | InvalidUnionValue {
  - contents :: Value
  }
- | SchemaMismatch {
  - a, b :: Schema
  }
- | ValueMismatch {
  - expected :: Schema
  - got :: Value
  }
- | EmptySchema
- | PrimValidatorMissing {
  - name :: Text
  }
- | PrimError {
  - name, primError :: Text
  }
- | PrimMismatch {
  - have, want :: Text
  }
- | InvalidChoice {
  - choiceNumber :: Int
  }
- | UnusedFields (HashSet Text)
- | AllAlternativesFailed {
  - mismatches :: [(Trace, Mismatch)]
  }
- | UnexpectedAllOf
- | NoMatches
type Validators = HashMap Text ValidatePrim
type ValidatePrim = Value -> Maybe Text
validate :: Validators -> Schema -> Value -> [(Trace, Mismatch)]
isSubtypeOf :: Validators -> Schema -> Schema -> Either [(Trace, Mismatch)] (Value -> Value)
type Path = Int
selectPath :: Path -> [a] -> Maybe a
tag :: Int -> Text
decodeAlternatives :: Value -> [(Value, Path)]
lookup :: (Eq a, Foldable f) => a -> f (a, b) -> Maybe b
emptyValue :: Value

Documentation

newtype SchemaName Source #

Constructors

SchemaName String

Instances

Eq SchemaName Source #
Instance details Defined in Schemas.Untyped Methods (==) :: SchemaName -> SchemaName -> Bool # (/=) :: SchemaName -> SchemaName -> Bool #
Show SchemaName Source #
Instance details Defined in Schemas.Untyped Methods showsPrec :: Int -> SchemaName -> ShowS # show :: SchemaName -> String # showList :: [SchemaName] -> ShowS #
IsString SchemaName Source #
Instance details Defined in Schemas.Untyped Methods fromString :: String -> SchemaName #
HasSchema SchemaName Source #
Instance details Defined in Schemas.Class Methods schema :: TypedSchema SchemaName Source #

data Schema Source #

A schema for untyped data, such as JSON or XML.

introduction forms: extractSchema, schemaFor, mempty
operations: isSubtypeOf, versions, coerce, validate
composition: '(<>)'

Constructors

Array Schema
StringMap Schema
Enum (NonEmpty Text)
Record (HashMap Text Field)
OneOf (NonEmpty Schema)	Decoding works for all alternatives, encoding only for one
Prim Text	Carries the name of primitive type
Named SchemaName Schema
Empty

Instances

Eq Schema Source #
Instance details Defined in Schemas.Untyped Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #
Show Schema Source #
Instance details Defined in Schemas.Untyped Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
Generic Schema Source #
Instance details Defined in Schemas.Untyped Associated Types type Rep Schema :: Type -> Type # Methods from :: Schema -> Rep Schema x # to :: Rep Schema x -> Schema #
Semigroup Schema Source #
Instance details Defined in Schemas.Untyped Methods (<>) :: Schema -> Schema -> Schema # sconcat :: NonEmpty Schema -> Schema # stimes :: Integral b => b -> Schema -> Schema #
Monoid Schema Source #
Instance details Defined in Schemas.Untyped Methods mempty :: Schema # mappend :: Schema -> Schema -> Schema # mconcat :: [Schema] -> Schema #
HasSchema Schema Source #
Instance details Defined in Schemas.Class Methods schema :: TypedSchema Schema Source #
type Rep Schema Source #
Instance details Defined in Schemas.Untyped type Rep Schema = D1 (MetaData "Schema" "Schemas.Untyped" "schemas-0.4.0.0-DT2P1byuCA4Iptxa9MvJ7g" False) (((C1 (MetaCons "Array" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema)) :+: C1 (MetaCons "StringMap" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema))) :+: (C1 (MetaCons "Enum" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty Text))) :+: C1 (MetaCons "Record" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text Field))))) :+: ((C1 (MetaCons "OneOf" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty Schema))) :+: C1 (MetaCons "Prim" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :+: (C1 (MetaCons "Named" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SchemaName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema)) :+: C1 (MetaCons "Empty" PrefixI False) (U1 :: Type -> Type))))

data Field Source #

Constructors

Field
Fields fieldSchema :: Schema isRequired :: Bool defaults to True

Instances

Eq Field Source #
Instance details Defined in Schemas.Untyped Methods (==) :: Field -> Field -> Bool # (/=) :: Field -> Field -> Bool #
Show Field Source #
Instance details Defined in Schemas.Untyped Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #
Generic Field Source #
Instance details Defined in Schemas.Untyped Associated Types type Rep Field :: Type -> Type # Methods from :: Field -> Rep Field x # to :: Rep Field x -> Field #
HasSchema Field Source #
Instance details Defined in Schemas.Class Methods schema :: TypedSchema Field Source #
type Rep Field Source #
Instance details Defined in Schemas.Untyped type Rep Field = D1 (MetaData "Field" "Schemas.Untyped" "schemas-0.4.0.0-DT2P1byuCA4Iptxa9MvJ7g" False) (C1 (MetaCons "Field" PrefixI True) (S1 (MetaSel (Just "fieldSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema) :*: S1 (MetaSel (Just "isRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

fieldSchemaL :: Applicative f => (Schema -> f Schema) -> Field -> f Field Source #

pattern Unit :: Schema Source #

pattern Union :: NonEmpty (Text, Schema) -> Schema Source #

_Unit :: Prism' Schema () Source #

_Union :: Prism' Schema (NonEmpty (Text, Schema)) Source #

type Trace = [Text] Source #

data Mismatch Source #

Constructors

MissingRecordField
Fields name :: Text
MissingEnumChoices
Fields choices :: NonEmpty Text
OptionalRecordField
Fields name :: Text
InvalidRecordField
Fields name :: Text
InvalidEnumValue
Fields given :: Text options :: NonEmpty Text
InvalidRecordValue
Fields value :: Value
InvalidConstructor
Fields name :: Text
InvalidUnionValue
Fields contents :: Value
SchemaMismatch
Fields a, b :: Schema
ValueMismatch
Fields expected :: Schema got :: Value
EmptySchema
PrimValidatorMissing
Fields name :: Text
PrimError
Fields name, primError :: Text
PrimMismatch
Fields have, want :: Text
InvalidChoice
Fields choiceNumber :: Int
UnusedFields (HashSet Text)
AllAlternativesFailed
Fields mismatches :: [(Trace, Mismatch)]
UnexpectedAllOf
NoMatches

Instances

Eq Mismatch Source #
Instance details Defined in Schemas.Untyped Methods (==) :: Mismatch -> Mismatch -> Bool # (/=) :: Mismatch -> Mismatch -> Bool #
Show Mismatch Source #
Instance details Defined in Schemas.Untyped Methods showsPrec :: Int -> Mismatch -> ShowS # show :: Mismatch -> String # showList :: [Mismatch] -> ShowS #
Exception Mismatch Source #
Instance details Defined in Schemas.Untyped Methods toException :: Mismatch -> SomeException # fromException :: SomeException -> Maybe Mismatch # displayException :: Mismatch -> String #
MonadError TracedMismatches Result Source #
Instance details Defined in Schemas.Internal Methods throwError :: TracedMismatches -> Result a # catchError :: Result a -> (TracedMismatches -> Result a) -> Result a #

type Validators = HashMap Text ValidatePrim Source #

type ValidatePrim = Value -> Maybe Text Source #

validate :: Validators -> Schema -> Value -> [(Trace, Mismatch)] Source #

Structural validation of a JSON value against a schema. Ignores extraneous fields in records

isSubtypeOf :: Validators -> Schema -> Schema -> Either [(Trace, Mismatch)] (Value -> Value) Source #

sub isSubtypeOf sup returns a witness that sub is a subtype of sup, i.e. a cast function sub -> sup

Array Bool `isSubtypeOf` Bool

Just function > Record [("a", Bool)] isSubtypeOf Record [("a", Number)] Nothing

type Path = Int Source #

selectPath :: Path -> [a] -> Maybe a Source #

tag :: Int -> Text Source #

decodeAlternatives :: Value -> [(Value, Path)] Source #

lookup :: (Eq a, Foldable f) => a -> f (a, b) -> Maybe b Source #

Generalized lookup for Foldables

emptyValue :: Value Source #