Module

Payload.Client.Client

type Options = { hostname :: String, port :: Int }

type ModifyRequest = Request String -> Request String

defaultOpts :: Options

class ClientApi routesSpec client | routesSpec -> client where

(RowToList routesSpec routesSpecList, ClientApiList routesSpecList "" () (Record client)) => ClientApi (Record routesSpec) (Record client)

class ClientApiList (routesSpecList :: RowList) (basePath :: Symbol) (baseParams :: Row Type) client | routesSpecList -> client where

mkClientList :: Options -> RLProxy routesSpecList -> SProxy basePath -> Proxy (Record baseParams) -> client

ClientApiList Nil basePath baseParams (Record ())
(IsSymbol routeName, IsSymbol method, IsSymbol path, Cons routeName (ModifyRequest -> payload -> Aff (Either String res)) remClient client, Lacks routeName remClient, ClientQueryable (Route method path routeSpec) basePath baseParams payload res, ClientApiList remRoutes basePath baseParams (Record remClient)) => ClientApiList (Cons routeName (Route method path routeSpec) remRoutes) basePath baseParams (Record client)
(IsSymbol parentName, IsSymbol basePath, IsSymbol path, Union parentSpec DefaultParentRoute mergedSpec, Nub mergedSpec parentSpecWithDefaults, TypeEquals (Record parentSpecWithDefaults) { guards :: parentGuards, params :: Record parentParams | childRoutes }, Append basePath path childBasePath, Union baseParams parentParams childParams, EncodeUrl path parentParams, RowToList childRoutes childRoutesList, ClientApiList childRoutesList childBasePath childParams (Record childClient), Lacks parentName remClient, Cons parentName (Record childClient) remClient client, ClientApiList remRoutes basePath baseParams (Record remClient)) => ClientApiList (Cons parentName (Routes path (Record parentSpec)) remRoutes) basePath baseParams (Record client)

class ClientQueryable route (basePath :: Symbol) (baseParams :: Row Type) payload res | route -> payload, route -> res where

request :: route -> SProxy basePath -> Proxy (Record baseParams) -> Options -> ModifyRequest -> payload -> Aff (Either String res)

(Union route DefaultRequest mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { params :: Record params, response :: res | r }, IsSymbol path, Append basePath path fullPath, EncodeUrl fullPath fullParams, Union baseParams params fullParams, ReadResponse res, ReadForeign res) => ClientQueryable (Route "GET" path (Record route)) basePath baseParams (Record fullParams) res
(Union route DefaultRequest mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { body :: body, params :: Record params, response :: res | r }, Union baseParams params fullParams, TypeEquals (Record payload) { body :: body | fullParams }, Lacks "body" fullParams, IsSymbol path, Append basePath path fullPath, EncodeUrl fullPath fullParams, ReadResponse res, WriteForeign body, ReadForeign res) => ClientQueryable (Route "POST" path (Record route)) basePath baseParams (Record payload) res

encodeUrl :: forall params path. EncodeUrl path params => Options -> SProxy path -> Record params -> String

decodeResponse :: forall res. ReadResponse res => (Response (Either ResponseFormatError String)) -> Either String res