Servant.Elm.Internal.Generate

Documentation

toElmTypeRefWith :: ElmOptions -> EType -> Text

toElmDecoderRefWith :: ElmOptions -> EType -> Text

toElmEncoderRefWith :: ElmOptions -> EType -> Text

data ElmOptions

Options to configure how code is generated.

Constructors

ElmOptions

Fields

• urlPrefix :: UrlPrefix

  The protocol, host and any path prefix to be used as the base for all requests.

  Example: Static "https://mydomain.com/api/v1"

  When Dynamic, the generated Elm functions take the base URL as the first argument.

• elmTypeAlterations :: EType -> EType

  Alterations to perform on ETypes before code generation.

• elmAlterations :: ETypeDef -> ETypeDef

  Alterations to perform on ETypeDefs before code generation.

• emptyResponseElmTypes :: [EType]

  Types that represent an empty Http response.

• stringElmTypes :: [EType]

  Types that represent a String.

data UrlPrefix

Constructors

Static Text

Dynamic

type Namespace = [String]

defElmOptions :: ElmOptions

Default options for generating Elm code.

The default options are:

{ urlPrefix =
    Static ""
, elmAlterations =
    Elm.defaultTypeAlterations
, emptyResponseElmTypes =
    [ getType (Proxy :: Proxy ()) ]
, stringElmTypes =
    [ getType (Proxy :: Proxy String)
    , getType (Proxy :: Proxy T.Text) ]
}

defElmImports :: Text

Default imports required by generated Elm code.

You probably want to include this at the top of your generated Elm module.

The default required imports are:

import Json.Decode
import Json.Encode exposing (Value)
-- The following module comes from bartavelle/json-helpers
import Json.Helpers exposing (..)
import Dict exposing (Dict)
import Set
import Http
import String
import Url.Builder

generateElmModuleWith :: (HasForeign LangElm EType api, GenerateList EType (Foreign EType api)) => ElmOptions -> Namespace -> Text -> FilePath -> [DefineElm] -> Proxy api -> IO ()

Helper to generate a complete Elm module given a list of Elm type definitions and an API.

generateElmModule :: (HasForeign LangElm EType api, GenerateList EType (Foreign EType api)) => Namespace -> Text -> FilePath -> [DefineElm] -> Proxy api -> IO ()

Calls generateElmModuleWith with defElmOptions.

generateElmForAPI :: (HasForeign LangElm EType api, GenerateList EType (Foreign EType api)) => Proxy api -> [Text]

Generate Elm code for the API with default options.

Returns a list of Elm functions to query your Servant API from Elm.

You could spit these out to a file and call them from your Elm code, but you would be better off creating a Spec with the result and using specsToDir, which handles the module name for you.

generateElmForAPIWith :: (HasForeign LangElm EType api, GenerateList EType (Foreign EType api)) => ElmOptions -> Proxy api -> [Text]

Generate Elm code for the API with custom options.

i :: Int

generateElmForRequest :: ElmOptions -> Req EType -> Doc

Generate an Elm function for one endpoint.

mkTypeSignature :: ElmOptions -> Req EType -> Doc

elmHeaderArg :: HeaderArg EType -> Doc

elmCaptureArg :: Segment EType -> Doc

elmQueryArg :: QueryArg EType -> Doc

elmBodyArg :: Doc

isNotCookie :: HeaderArg f -> Bool

mkArgs :: ElmOptions -> Req EType -> Doc

mkLetParams :: ElmOptions -> Req EType -> Maybe Doc

mkRequest :: ElmOptions -> Req EType -> Doc

renderDecoderName :: EType -> Doc

mkUrl :: ElmOptions -> [Segment EType] -> Doc

mkQueryParams :: Req EType -> Doc

isEmptyType :: ElmOptions -> EType -> Bool

Determines whether we construct an Elm function that expects an empty response body.

isElmStringType :: ElmOptions -> EType -> Bool

Determines whether we call toString on URL captures and query params of this type in Elm.

isElmMaybeStringType :: ElmOptions -> EType -> Bool

Determines whether a type is 'Maybe a' where a is something akin to a String.

isElmMaybeType :: EType -> Bool

isElmListOfMaybeBoolType :: EType -> Bool

docToText :: Doc -> Text

stext :: Text -> Doc

elmRecord :: [Doc] -> Doc

elmList :: [Doc] -> Doc

elmListOfMaybes :: [Doc] -> Doc