Network.Wai.Serve.Types

Types used by the Kawaii package.

Middleware Stack

data MiddlewareStack

A middleware stack is a simple container of Wai middleware. The top of the stack is considered to be the outermost layer of middleware while the bottom of the stack is the innermost layer of middleware.

The stack is a Monoid, so it can be combined with other stacks using <>, and an empty one can be obtained using mempty.

Constructors

MiddlewareStack [Middleware]

The constructor takes a list of middleware, where the left-most item in the list will end up at the top of the stack, and the right-most at the bottom.

Instances

Monoid MiddlewareStack

Methods

mempty :: MiddlewareStack

mappend :: MiddlewareStack -> MiddlewareStack -> MiddlewareStack

mconcat :: [MiddlewareStack] -> MiddlewareStack

Server configuration

data ServeConfiguration

The configuration for the server process.

The different transforms can be used to specify how the configuration changes depending on the stage. While starting up, the server process will take the base configuration, check the stage and pass the configuration through the appropriate transformer.

Constructors

ServeConfiguration

Fields

• _scMiddleware :: MiddlewareStack

  Base middleware stack.

• _scDevTransform :: ServeConfiguration -> ServeConfiguration

  Developer stage configuration transformer.

• _scStagingTransform :: ServeConfiguration -> ServeConfiguration

  Staging stage configuration transfomer.

• _scProdTransform :: ServeConfiguration -> ServeConfiguration

  Production stage configuration transfomer.

• _scTlsConfiguration :: Maybe TLSConfiguration

  TLS/SSL configuration. If it's not provided, a TLS listener will not be started.

• _scPort :: Int

  Port to start the non-TLS server.

• _scStage :: Stage

  The current stage. This selects which transformer is used before starting the server.

• _scPath :: Maybe FilePath

  Path where the source of built site is located. Defaults to _site.

Instances

Default ServeConfiguration

Methods

def :: ServeConfiguration

data TLSConfiguration

The configuration for the TLS/HTTPS server.

Constructors

TLSConfiguration

Fields

• _tlsMiddleware :: MiddlewareStack -> MiddlewareStack

  A function for modifying or completely replacing the middleware stack for the TLS server.

• _tlsSettings :: TLSSettings

  Warp TLSSettings, which can be used to provide certificates.

• _tlsPort :: Int

  Port to start the TLS server.

CSP

type SourceList = [Text]

type TypeList = [Text]

data Directive

Constructors

BaseURI SourceList

ChildSrc SourceList

ConnectSrc SourceList

DefaultSrc SourceList

FontSrc SourceList

FormAction SourceList

FrameAncestors SourceList

FrameSrc SourceList

ImgSrc SourceList

ManifestSrc SourceList

MediaSrc SourceList

ObjectSrc SourceList

PluginTypes TypeList

Referrer Text

ReflectedXSS Text

ReportURI Text

Sandbox Text

ScriptSrc SourceList

StyleSrc SourceList

UpgradeInsecureRequests

Miscellaneous types

type Domain = ByteString

data Stage

The development stage an application is executing in.

This is used to alter the behavior of the server depending on the stage of development. For example, a local development server might only have an HTTP listener and a smaller middleware stack, while a production server also listens for TLS connections and has additional middlewares that only make sense on a public server.

Constructors

Development

Staging

Production

Instances

Show Stage

Methods

showsPrec :: Int -> Stage -> ShowS

show :: Stage -> String

showList :: [Stage] -> ShowS

Lenses

scMiddleware :: Lens' ServeConfiguration MiddlewareStack

scDevTransform :: Lens' ServeConfiguration (ServeConfiguration -> ServeConfiguration)

scStagingTransform :: Lens' ServeConfiguration (ServeConfiguration -> ServeConfiguration)

scProdTransform :: Lens' ServeConfiguration (ServeConfiguration -> ServeConfiguration)

scTlsConfiguration :: Lens' ServeConfiguration (Maybe TLSConfiguration)

scPort :: Lens' ServeConfiguration Int

scStage :: Lens' ServeConfiguration Stage

scPath :: Lens' ServeConfiguration (Maybe FilePath)

tlsMiddleware :: Lens' TLSConfiguration (MiddlewareStack -> MiddlewareStack)

tlsSettings :: Lens' TLSConfiguration TLSSettings

tlsPort :: Lens' TLSConfiguration Int