-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | TypeScript client generation for Servant
--   
--   Please see the README on GitHub at
--   <a>https://github.com/codedownio/servant-typescript</a>
@package servant-typescript
@version 0.1.0.2

module Servant.TypeScript.GetFunctions

-- | Default implementation of <tt>getFunctions</tt>.
getFunctions :: (Req Text -> Text) -> [Req Text] -> Text


-- | This library generates TypeScript client libraries for Servant.
--   
--   First, make sure you have <a>TypeScript</a> instances defined for all
--   of the types used in the API.
--   
--   <pre>
--   data User = User {
--     name :: String
--     , age :: Int
--     , email :: String
--     } deriving (Eq, Show)
--   deriveJSONAndTypeScript A.defaultOptions ''User
--   </pre>
--   
--   If you need to generate lots of boilerplate instances, the functions
--   in <tt>aeson-typescript</tt>'s <a>Recursive</a> module can be your
--   friend. I've used
--   <a>recursivelyDeriveMissingTypeScriptInstancesFor</a> to derive
--   instances for the Kubernetes API.
--   
--   Next, you'll need some Servant API:
--   
--   <pre>
--   type UserAPI = "users" :&gt; Get '[JSON] [User]
--             :&lt;|&gt; "albert" :&gt; Get '[JSON] User
--             :&lt;|&gt; "isaac" :&gt; Get '[JSON] User
--   </pre>
--   
--   Generating the library is as simple as this:
--   
--   <pre>
--   main = writeTypeScriptLibrary (Proxy :: Proxy UserAPI) "/my/destination/folder/"
--   </pre>
module Servant.TypeScript

-- | Write the TypeScript client library for the given API to the given
--   folder using default options.
writeTypeScriptLibrary :: MainConstraints api => Proxy api -> FilePath -> IO ()

-- | Write the TypeScript client library for the given API to the given
--   folder.
writeTypeScriptLibrary' :: forall api. MainConstraints api => ServantTypeScriptOptions -> Proxy api -> FilePath -> IO ()
data ServantTypeScriptOptions

-- | Reasonable default options.
defaultServantTypeScriptOptions :: ServantTypeScriptOptions

-- | Extra TypeScript types to include in the <tt>d.ts</tt> file.
--   
--   Useful if you want to expose types that don't appear in your API, for
--   whatever reason.
extraTypes :: ServantTypeScriptOptions -> [TSType]

-- | Determine to which output file the client function for the given
--   request is mapped.
--   
--   Useful to break up larger APIs into separate files based on criteria
--   like route prefixes.
--   
--   It's fine if the file key contains sub-directories; they will be
--   created as needed.
--   
--   A good approach is to split on <tt>case req ^. (reqFuncName .
--   _FunctionName) of ...</tt>.
--   
--   Default implementation is <tt>const "client.ts"</tt>.
getFileKey :: ServantTypeScriptOptions -> Req Text -> FilePath

-- | Mangle a given request into a corresponding client function name. By
--   default, just prepends the HTTP method to the camel-cased route.
getFunctionName :: ServantTypeScriptOptions -> Req Text -> Text

-- | Given a list of requests, output a complete TypeScript module with the
--   (exported) client functions, ready to be consumed by your TypeScript
--   app.
--   
--   For example, you can import dependencies at the top to use in your
--   functions. The default version relies on the NPM "query-string"
--   package to construct URLs. It uses the built-in <tt>window.fetch</tt>
--   by default, but allows you to pass your own <tt>fetch</tt> function
--   instead (useful for server-side rendering etc.). The default client
--   functions return <tt>Promise</tt>s with the given return value, and on
--   failure they reject the promise with a value of interface <tt>{
--   status: number; text: string; }</tt>.
--   
--   If you want to write your own <a>getFunctions</a>, check out the
--   <a>GetFunctions</a> module for inspiration.
--   
--   The first argument passed to <a>getFunctions</a> is the
--   <a>getFunctionName</a> function.
getFunctions :: ServantTypeScriptOptions -> (Req Text -> Text) -> [Req Text] -> Text
type MainConstraints api = (HasForeign LangTSDecls [TSDeclaration] api, GenerateList [TSDeclaration] (Foreign [TSDeclaration] api), HasForeign LangTS Text api, GenerateList Text (Foreign Text api))