Copyright	(C) 2014 Alp Mestanogullari
License	BSD3
Maintainer	Alp Mestanogullari <alpmestan@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Servant.JQuery

Description

Synopsis

Documentation

jquery :: HasJQ layout => Proxy layout -> JQ layout Source

generateJS :: AjaxReq -> String Source

jsForAPI :: (HasJQ api, GenerateCode (JQ api)) => Proxy api -> String Source

Directly generate all the javascript functions for your API from a Proxy for your API type. You can then write it to a file or integrate it in a page, for example.

printJS :: AjaxReq -> IO () Source

type Arg = String Source

data Segment Source

Constructors

Segment
Fields _segment :: SegmentType _matrix :: [MatrixArg]

Instances

Eq Segment
Show Segment

data SegmentType Source

Constructors

Static String	a static path segment. like "/foo"
Cap Arg	a capture. like "/:userid"

Instances

Eq SegmentType
Show SegmentType

type Path = [Segment] Source

data ArgType Source

Constructors

Normal
Flag
List

Instances

Eq ArgType
Show ArgType

data QueryArg Source

Constructors

QueryArg
Fields _argName :: Arg _argType :: ArgType

Instances

Eq QueryArg
Show QueryArg

data HeaderArg Source

Constructors

HeaderArg
Fields headerArgName :: String
ReplaceHeaderArg
Fields headerArgName :: String headerPattern :: String

Instances

Eq HeaderArg
Show HeaderArg

toValidFunctionName :: String -> String Source

Attempts to reduce the function name provided to that allowed by JS. https://mathiasbynens.be/notes/javascript-identifiers Couldn't work out how to handle zero-width characters. @TODO: specify better default function name, or throw error?

type MatrixArg = QueryArg Source

data Url Source

Constructors

Url
Fields _path :: Path _queryStr :: [QueryArg]

Instances

Eq Url
Show Url

defUrl :: Url Source

type FunctionName = String Source

type Method = String Source

data AjaxReq Source

Constructors

AjaxReq
Fields _reqUrl :: Url _reqMethod :: Method _reqHeaders :: [HeaderArg] _reqBody :: Bool _funcName :: FunctionName

Instances

Eq AjaxReq
Show AjaxReq
GenerateCode AjaxReq
GenerateCode rest => GenerateCode ((:<\|>) AjaxReq rest)

argType :: Lens' QueryArg ArgType Source

argName :: Lens' QueryArg Arg Source

segment :: Lens' Segment SegmentType Source

matrix :: Lens' Segment [MatrixArg] Source

queryStr :: Lens' Url [QueryArg] Source

path :: Lens' Url Path Source

reqUrl :: Lens' AjaxReq Url Source

reqMethod :: Lens' AjaxReq Method Source

reqHeaders :: Lens' AjaxReq [HeaderArg] Source

reqBody :: Lens' AjaxReq Bool Source

funcName :: Lens' AjaxReq FunctionName Source

isCapture :: Segment -> Bool Source

hasMatrixArgs :: Segment -> Bool Source

hasArgs :: Segment -> Bool Source

matrixArgs :: Segment -> [MatrixArg] Source

captureArg :: Segment -> Arg Source

jsSegments :: [Segment] -> String Source

segmentToStr :: Segment -> Bool -> String Source

segmentTypeToStr :: SegmentType -> String Source

jsGParams :: String -> [QueryArg] -> String Source

jsParams :: [QueryArg] -> String Source

jsMParams :: [MatrixArg] -> String Source

paramToStr :: QueryArg -> Bool -> String Source

defReq :: AjaxReq Source

type family Elem a ls :: Constraint Source

Equations

Elem a [] = False ~ True
Elem a (a : list) = ()
Elem a (b : list) = Elem a list

class HasJQ layout where Source

Associated Types

type JQ layout :: * Source

Methods

jqueryFor :: Proxy layout -> AjaxReq -> JQ layout Source

Instances

HasJQ Raw
(HasJQ a, HasJQ b) => HasJQ ((:<\|>) a b)
Elem JSON list => HasJQ (Get list a)
Elem JSON list => HasJQ (Post list a)
Elem JSON list => HasJQ (Delete list a)
Elem JSON list => HasJQ (Put list a)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (Capture * sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (Header sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (QueryParam * sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (QueryParams * sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (QueryFlag sym) sublayout)
(Elem JSON list, HasJQ sublayout) => HasJQ ((:>) * * (ReqBody * list a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (MatrixParam * sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (MatrixParams * sym a) sublayout)
(KnownSymbol sym, HasJQ sublayout) => HasJQ ((:>) * * (MatrixFlag sym) sublayout)
(KnownSymbol path, HasJQ sublayout) => HasJQ ((:>) Symbol * path sublayout)

class GenerateCode reqs where Source

Utility class used by jsForAPI which will directly hand you all the Javascript code instead of handing you a :<|>-separated list of AjaxReq like jquery and then having to use generateJS on each AjaxReq.

Methods

jsFor :: reqs -> String Source

Instances

GenerateCode AjaxReq
GenerateCode rest => GenerateCode ((:<\|>) AjaxReq rest)