Data.Aeson.AutoType.Nested

Simple interface for using AutoType inference in other code generators.

Simply takes a list of Aeson values, and returns a type description.

For this type description, we can use function to generate an entire new module.

Note that while we can put more code in the module, it is recommended to avoid multiple automatically generated types in order to avoid name conflicts.

NOTE: this interface is yet unstable

Documentation

defaultImportedModules :: [ModuleImport]

List of modules imported for Autotyped declarations

generateModuleImports :: [ModuleImport] -> Text

Given a list of imports, generate source code.

inferType :: Text -> [Value] -> TypeFrag

Given intended type name, and a list of text fields with JSON, return either an error, or an EndpointResponse that allows to declare and use this type in generated module.

data CodeFrag a

Generated code reference and its requirements Content to embed in an autogenerated module:

• name of the reference
• declarations to describe it
• module imports necessary for declarations to work

Constructors

CodeFrag

Fields

• codeFragCode :: Code

  Code fragment to be inserted in generated module

• codeFragName :: a

  Toplevel type name to refer to

• codeFragImports :: [ModuleImport]

  List of clauses to add to imports list

• codeFragPackages :: [PackageName]

  List of packages to add to generated package dependencies

Instances

Default TypeFrag

Defined in Data.Aeson.AutoType.Nested

Methods

def :: TypeFrag

Eq a => Eq (CodeFrag a)

Defined in Data.Aeson.AutoType.Nested

Methods

(==) :: CodeFrag a -> CodeFrag a -> Bool

(/=) :: CodeFrag a -> CodeFrag a -> Bool

Show a => Show (CodeFrag a)

Defined in Data.Aeson.AutoType.Nested

Methods

showsPrec :: Int -> CodeFrag a -> ShowS

show :: CodeFrag a -> String

showList :: [CodeFrag a] -> ShowS

Generic (CodeFrag a)

Defined in Data.Aeson.AutoType.Nested

Associated Types

type Rep (CodeFrag a) :: Type -> Type

Methods

from :: CodeFrag a -> Rep (CodeFrag a) x

to :: Rep (CodeFrag a) x -> CodeFrag a

type Rep (CodeFrag a)

Defined in Data.Aeson.AutoType.Nested

type Rep (CodeFrag a)

type TypeName = Text

type TypeFrag = CodeFrag TypeName

type ModuleImport = Text

Alias for indicating that this is item in module imports list.

type PackageName = Text