hydra-ext-0.17.4: src/main/haskell/Hydra/Json/Schema/Serde.hs
-- Note: this is an automatically generated file. Do not edit.
-- | Serialization functions for converting JSON Schema documents to JSON values
module Hydra.Json.Schema.Serde where
import qualified Hydra.Ast as Ast
import qualified Hydra.Coders as Coders
import qualified Hydra.Core as Core
import qualified Hydra.Docs as Docs
import qualified Hydra.Error.Checking as Checking
import qualified Hydra.Error.Core as ErrorCore
import qualified Hydra.Error.File as ErrorFile
import qualified Hydra.Error.Packaging as ErrorPackaging
import qualified Hydra.Error.System as ErrorSystem
import qualified Hydra.Errors as Errors
import qualified Hydra.File as File
import qualified Hydra.Graph as Graph
import qualified Hydra.Json.Model as Model
import qualified Hydra.Json.Schema.Model as SchemaModel
import qualified Hydra.Json.Writer as Writer
import qualified Hydra.Overlay.Haskell.Lib.Lists as Lists
import qualified Hydra.Overlay.Haskell.Lib.Literals as Literals
import qualified Hydra.Overlay.Haskell.Lib.Logic as Logic
import qualified Hydra.Overlay.Haskell.Lib.Maps as Maps
import qualified Hydra.Overlay.Haskell.Lib.Optionals as Optionals
import qualified Hydra.Overlay.Haskell.Lib.Pairs as Pairs
import qualified Hydra.Packaging as Packaging
import qualified Hydra.Parsing as Parsing
import qualified Hydra.Paths as Paths
import qualified Hydra.Query as Query
import qualified Hydra.Regex as Regex
import qualified Hydra.Relational as Relational
import qualified Hydra.System as System
import qualified Hydra.Tabular as Tabular
import qualified Hydra.Testing as Testing
import qualified Hydra.Time as Time
import qualified Hydra.Topology as Topology
import qualified Hydra.Typed as Typed
import qualified Hydra.Typing as Typing
import qualified Hydra.Util as Util
import qualified Hydra.Validation as Validation
import qualified Hydra.Variants as Variants
import Prelude hiding (Enum, Ordering, decodeFloat, encodeFloat, fail, map, pure, sum)
import qualified Data.Scientific as Sci
import qualified Data.Map as M
-- | Encode additional items as a JSON value
additionalItemsToExpr :: SchemaModel.AdditionalItems -> Model.Value
additionalItemsToExpr ai =
case ai of
SchemaModel.AdditionalItemsAny v0 -> Model.ValueBoolean v0
SchemaModel.AdditionalItemsSchema v0 -> schemaToExpr v0
-- | Encode an array restriction as a key-value pair
arrayRestrictionToExpr :: SchemaModel.ArrayRestriction -> (String, Model.Value)
arrayRestrictionToExpr r =
case r of
SchemaModel.ArrayRestrictionItems v0 -> itemsToExpr v0
SchemaModel.ArrayRestrictionAdditionalItems v0 -> (keyAdditionalItems, (additionalItemsToExpr v0))
SchemaModel.ArrayRestrictionMinItems v0 -> (keyMinItems, (integerToExpr v0))
SchemaModel.ArrayRestrictionMaxItems v0 -> (keyMaxItems, (integerToExpr v0))
SchemaModel.ArrayRestrictionUniqueItems v0 -> (keyUniqueItems, (Model.ValueBoolean v0))
-- | Extract a name-keyed map from a JSON object value (field order is dropped)
fromObject :: Model.Value -> M.Map String Model.Value
fromObject v =
case v of
Model.ValueObject v0 -> Maps.fromList v0
-- | Encode an integer as a JSON number value
integerToExpr :: Int -> Model.Value
integerToExpr n = Model.ValueNumber (Literals.bigintToDecimal (Literals.int32ToBigint n))
-- | Encode items as a key-value pair
itemsToExpr :: SchemaModel.Items -> (String, Model.Value)
itemsToExpr items =
(
keyItems,
case items of
SchemaModel.ItemsSameItems v0 -> schemaToExpr v0
SchemaModel.ItemsVarItems v0 -> Model.ValueArray (Lists.map schemaToExpr v0))
-- | Convert a JSON Schema document to a JSON value
jsonSchemaDocumentToJsonValue :: SchemaModel.Document -> Model.Value
jsonSchemaDocumentToJsonValue doc =
let mid = SchemaModel.documentId doc
mdefs = SchemaModel.documentDefinitions doc
root = SchemaModel.documentRoot doc
schemaMap = fromObject (schemaToExpr root)
restMap =
fromObject (toObject [
(keyId, (Optionals.map (\i -> Model.ValueString i) mid)),
(keySchema, (Optionals.pure (Model.ValueString "http://json-schema.org/2020-12/schema"))),
(
keyDefinitions,
(Optionals.map (\mp -> Model.ValueObject (Lists.map (\p ->
let k = Pairs.first p
schema = Pairs.second p
in (SchemaModel.unKeyword k, (schemaToExpr schema))) (Maps.toList mp))) mdefs))])
in (Model.ValueObject (Maps.toList (Maps.union schemaMap restMap)))
-- | Convert a JSON Schema document to a JSON string
jsonSchemaDocumentToString :: SchemaModel.Document -> String
jsonSchemaDocumentToString doc = Writer.printJson (jsonSchemaDocumentToJsonValue doc)
-- | The JSON Schema "additionalItems" keyword
keyAdditionalItems :: String
keyAdditionalItems = "additionalItems"
-- | The JSON Schema "additionalProperties" keyword
keyAdditionalProperties :: String
keyAdditionalProperties = "additionalProperties"
-- | The JSON Schema "allOf" keyword
keyAllOf :: String
keyAllOf = "allOf"
-- | The JSON Schema "anyOf" keyword
keyAnyOf :: String
keyAnyOf = "anyOf"
-- | The JSON Schema "$defs" keyword, used for reusable schema definitions
keyDefinitions :: String
keyDefinitions = "$defs"
-- | The JSON Schema "dependencies" keyword
keyDependencies :: String
keyDependencies = "dependencies"
-- | The JSON Schema "description" keyword
keyDescription :: String
keyDescription = "description"
-- | The JSON Schema "enum" keyword
keyEnum :: String
keyEnum = "enum"
-- | The JSON Schema "exclusiveMaximum" keyword
keyExclusiveMaximum :: String
keyExclusiveMaximum = "exclusiveMaximum"
-- | The JSON Schema "exclusiveMinimum" keyword
keyExclusiveMinimum :: String
keyExclusiveMinimum = "exclusiveMinimum"
-- | The JSON Schema "$id" keyword, identifying the schema
keyId :: String
keyId = "$id"
-- | The JSON Schema "items" keyword
keyItems :: String
keyItems = "items"
-- | The JSON Schema "label" keyword
keyLabel :: String
keyLabel = "label"
-- | The JSON Schema "maxItems" keyword
keyMaxItems :: String
keyMaxItems = "maxItems"
-- | The JSON Schema "maxLength" keyword
keyMaxLength :: String
keyMaxLength = "maxLength"
-- | The JSON Schema "maxProperties" keyword
keyMaxProperties :: String
keyMaxProperties = "maxProperties"
-- | The JSON Schema "maximum" keyword
keyMaximum :: String
keyMaximum = "maximum"
-- | The JSON Schema "minItems" keyword
keyMinItems :: String
keyMinItems = "minItems"
-- | The JSON Schema "minLength" keyword
keyMinLength :: String
keyMinLength = "minLength"
-- | The JSON Schema "minProperties" keyword
keyMinProperties :: String
keyMinProperties = "minProperties"
-- | The JSON Schema "minimum" keyword
keyMinimum :: String
keyMinimum = "minimum"
-- | The JSON Schema "multipleOf" keyword
keyMultipleOf :: String
keyMultipleOf = "multipleOf"
-- | The JSON Schema "not" keyword
keyNot :: String
keyNot = "not"
-- | The JSON Schema "oneOf" keyword
keyOneOf :: String
keyOneOf = "oneOf"
-- | The JSON Schema "pattern" keyword
keyPattern :: String
keyPattern = "pattern"
-- | The JSON Schema "patternProperties" keyword
keyPatternProperties :: String
keyPatternProperties = "patternProperties"
-- | The JSON Schema "properties" keyword
keyProperties :: String
keyProperties = "properties"
-- | The JSON Schema "$ref" keyword, used for schema references
keyRef :: String
keyRef = "$ref"
-- | The JSON Schema "required" keyword
keyRequired :: String
keyRequired = "required"
-- | The JSON Schema "$schema" keyword, identifying the schema dialect
keySchema :: String
keySchema = "$schema"
-- | The JSON Schema "title" keyword
keyTitle :: String
keyTitle = "title"
-- | The JSON Schema "type" keyword
keyType :: String
keyType = "type"
-- | The JSON Schema "uniqueItems" keyword
keyUniqueItems :: String
keyUniqueItems = "uniqueItems"
-- | Encode a keyword-schema-or-array pair as a key-value pair
keywordSchemaOrArrayToExpr :: (SchemaModel.Keyword, SchemaModel.SchemaOrArray) -> (String, Model.Value)
keywordSchemaOrArrayToExpr p =
let k = Pairs.first p
s = Pairs.second p
in (SchemaModel.unKeyword k, (schemaOrArrayToExpr s))
-- | Encode a keyword as a JSON string value
keywordToExpr :: SchemaModel.Keyword -> Model.Value
keywordToExpr k = Model.ValueString (SchemaModel.unKeyword k)
-- | Encode a multiple restriction as a key-value pair
multipleRestrictionToExpr :: SchemaModel.MultipleRestriction -> (String, Model.Value)
multipleRestrictionToExpr r =
case r of
SchemaModel.MultipleRestrictionAllOf v0 -> (keyAllOf, (Model.ValueArray (Lists.map schemaToExpr v0)))
SchemaModel.MultipleRestrictionAnyOf v0 -> (keyAnyOf, (Model.ValueArray (Lists.map schemaToExpr v0)))
SchemaModel.MultipleRestrictionOneOf v0 -> (keyOneOf, (Model.ValueArray (Lists.map schemaToExpr v0)))
SchemaModel.MultipleRestrictionNot v0 -> (keyNot, (schemaToExpr v0))
SchemaModel.MultipleRestrictionEnum v0 -> (keyEnum, (Model.ValueArray v0))
-- | Encode a numeric restriction as a list of key-value pairs
numericRestrictionToExpr :: SchemaModel.NumericRestriction -> [(String, Model.Value)]
numericRestrictionToExpr r =
case r of
SchemaModel.NumericRestrictionMinimum v0 ->
let value = SchemaModel.limitValue v0
excl = SchemaModel.limitExclusive v0
in (Lists.concat [
[
(keyMinimum, (integerToExpr value))],
(Logic.ifElse excl [
(keyExclusiveMinimum, (Model.ValueBoolean True))] [])])
SchemaModel.NumericRestrictionMaximum v0 ->
let value = SchemaModel.limitValue v0
excl = SchemaModel.limitExclusive v0
in (Lists.concat [
[
(keyMaximum, (integerToExpr value))],
(Logic.ifElse excl [
(keyExclusiveMaximum, (Model.ValueBoolean True))] [])])
SchemaModel.NumericRestrictionMultipleOf v0 -> [
(keyMultipleOf, (integerToExpr v0))]
-- | Encode an object restriction as a key-value pair
objectRestrictionToExpr :: SchemaModel.ObjectRestriction -> (String, Model.Value)
objectRestrictionToExpr r =
case r of
SchemaModel.ObjectRestrictionProperties v0 -> (keyProperties, (Model.ValueObject (Lists.map propertyToExpr (Maps.toList v0))))
SchemaModel.ObjectRestrictionAdditionalProperties v0 -> (keyAdditionalProperties, (additionalItemsToExpr v0))
SchemaModel.ObjectRestrictionRequired v0 -> (keyRequired, (Model.ValueArray (Lists.map keywordToExpr v0)))
SchemaModel.ObjectRestrictionMinProperties v0 -> (keyMinProperties, (integerToExpr v0))
SchemaModel.ObjectRestrictionMaxProperties v0 -> (keyMaxProperties, (integerToExpr v0))
SchemaModel.ObjectRestrictionDependencies v0 -> (keyDependencies, (Model.ValueObject (Lists.map keywordSchemaOrArrayToExpr (Maps.toList v0))))
SchemaModel.ObjectRestrictionPatternProperties v0 -> (keyPatternProperties, (Model.ValueObject (Lists.map patternPropertyToExpr (Maps.toList v0))))
-- | Encode a pattern property pair as a key-value pair
patternPropertyToExpr :: (SchemaModel.RegularExpression, SchemaModel.Schema) -> (String, Model.Value)
patternPropertyToExpr p =
let pat = Pairs.first p
s = Pairs.second p
in (SchemaModel.unRegularExpression pat, (schemaToExpr s))
-- | Encode a property pair as a key-value pair
propertyToExpr :: (SchemaModel.Keyword, SchemaModel.Schema) -> (String, Model.Value)
propertyToExpr p =
let k = Pairs.first p
s = Pairs.second p
in (SchemaModel.unKeyword k, (schemaToExpr s))
-- | Encode a restriction as a list of key-value pairs
restrictionToExpr :: SchemaModel.Restriction -> [(String, Model.Value)]
restrictionToExpr r =
case r of
SchemaModel.RestrictionType v0 -> [
(keyType, (typeToExpr v0))]
SchemaModel.RestrictionString v0 -> [
stringRestrictionToExpr v0]
SchemaModel.RestrictionNumber v0 -> numericRestrictionToExpr v0
SchemaModel.RestrictionArray v0 -> [
arrayRestrictionToExpr v0]
SchemaModel.RestrictionObject v0 -> [
objectRestrictionToExpr v0]
SchemaModel.RestrictionMultiple v0 -> [
multipleRestrictionToExpr v0]
SchemaModel.RestrictionReference v0 -> [
(keyRef, (schemaReferenceToExpr v0))]
SchemaModel.RestrictionTitle v0 -> [
(keyTitle, (Model.ValueString v0))]
SchemaModel.RestrictionDescription v0 -> [
(keyDescription, (Model.ValueString v0))]
-- | Encode a schema or array as a JSON value
schemaOrArrayToExpr :: SchemaModel.SchemaOrArray -> Model.Value
schemaOrArrayToExpr soa =
case soa of
SchemaModel.SchemaOrArraySchema v0 -> schemaToExpr v0
SchemaModel.SchemaOrArrayArray v0 -> Model.ValueArray (Lists.map keywordToExpr v0)
-- | Encode a schema reference as a JSON string value
schemaReferenceToExpr :: SchemaModel.SchemaReference -> Model.Value
schemaReferenceToExpr sr = Model.ValueString (SchemaModel.unSchemaReference sr)
-- | Encode a schema as a JSON object value
schemaToExpr :: SchemaModel.Schema -> Model.Value
schemaToExpr s = Model.ValueObject (Lists.concat (Lists.map restrictionToExpr (SchemaModel.unSchema s)))
-- | Encode a string restriction as a key-value pair
stringRestrictionToExpr :: SchemaModel.StringRestriction -> (String, Model.Value)
stringRestrictionToExpr r =
case r of
SchemaModel.StringRestrictionMaxLength v0 -> (keyMaxLength, (Model.ValueNumber (Literals.bigintToDecimal (Literals.int32ToBigint v0))))
SchemaModel.StringRestrictionMinLength v0 -> (keyMinLength, (Model.ValueNumber (Literals.bigintToDecimal (Literals.int32ToBigint v0))))
SchemaModel.StringRestrictionPattern v0 -> (keyPattern, (Model.ValueString (SchemaModel.unRegularExpression v0)))
-- | Construct a JSON object from a list of optional key-value pairs, filtering out Nothing values
toObject :: [(String, (Maybe Model.Value))] -> Model.Value
toObject pairs =
Model.ValueObject (Optionals.givens (Lists.map (\p ->
let k = Pairs.first p
mv = Pairs.second p
in (Optionals.map (\v -> (k, v)) mv)) pairs))
-- | Encode a type name as a JSON string value
typeNameToExpr :: SchemaModel.TypeName -> Model.Value
typeNameToExpr t =
case t of
SchemaModel.TypeNameString -> Model.ValueString "string"
SchemaModel.TypeNameInteger -> Model.ValueString "integer"
SchemaModel.TypeNameNumber -> Model.ValueString "number"
SchemaModel.TypeNameBoolean -> Model.ValueString "boolean"
SchemaModel.TypeNameNull -> Model.ValueString "null"
SchemaModel.TypeNameArray -> Model.ValueString "array"
SchemaModel.TypeNameObject -> Model.ValueString "object"
-- | Encode a type as a JSON value
typeToExpr :: SchemaModel.Type -> Model.Value
typeToExpr t =
case t of
SchemaModel.TypeSingle v0 -> typeNameToExpr v0
SchemaModel.TypeMultiple v0 -> Model.ValueArray (Lists.map typeNameToExpr v0)