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


-- | Haskell on AWS Lambda Runtime API
--   
--   Make "native" Haskell AWS Lambda (using Runtime API).
--   
--   <ul>
--   <li><a>AWS.Lambda.RuntimeAPI</a> is for writing lambdas</li>
--   <li><a>AWS.Lambda.RuntimeAPI.Package</a> is for packaging them.</li>
--   </ul>
@package aws-lambda-runtime
@version 0.0.0.1


-- | Based on the logic as implemented in
--   <a>https://github.com/awslabs/aws-lambda-cpp</a>
module AWS.Lambda.RuntimeAPI

-- | Default main to implement AWS Lambda using Runtime API
defaultMain :: (Request -> IO Response) -> IO ()

-- | Like <a>defaultMain</a> but work with JSON
jsonMain :: (FromJSON a, ToJSON b) => (GenRequest a -> IO b) -> IO ()

-- | Check the existence of <tt>AWS_LAMBDA_RUNTIME_API</tt> environment
--   variable.
--   
--   If it exists, assume we are running in AWS Lambda environment, i.e.
--   run normally. Otherwise use supplied <tt>MockOptions</tt>
autoMockMain :: Mock -> (Request -> IO Response) -> IO ()

-- | Like <a>autoMockMain</a> but works with JSON
autoMockJsonMain :: (FromJSON a, ToJSON b) => GenMock a -> (GenRequest a -> IO b) -> IO ()
type Mock = GenMock ByteString

-- | How to mock the <a>Request</a>, what to do with the <a>Response</a>.
data GenMock a
Mock :: IO (GenRequest a) -> (Response -> IO ()) -> GenMock a
[mockRequest] :: GenMock a -> IO (GenRequest a)
[mockResponse] :: GenMock a -> Response -> IO ()

-- | Create <a>Mock</a> request
makeMockRequest :: a -> Int64 -> IO (GenRequest a)

-- | Request with <a>ByteString</a> payload
type Request = GenRequest ByteString
data Response
SuccessResponse :: !MediaType -> !ByteString -> Response

-- | error type, error message
FailureResponse :: !Text -> !Text -> Response
data GenRequest a
Request :: !a -> !RequestId -> !ByteString -> !ByteString -> !ByteString -> !ByteString -> !Deadline -> GenRequest a

-- | The user's payload represented (originally) as a UTF-8 string.
[requestPayload] :: GenRequest a -> !a

-- | And identifier unique to the current invocation.
[requestId] :: GenRequest a -> !RequestId

-- | X-Ray tracigng of the current invocation.
[requestXRayTraceId] :: GenRequest a -> !ByteString

-- | Information about the client application and device when invoked
--   through the AWS Mobile SDK.
[requestClientContext] :: GenRequest a -> !ByteString

-- | Information about the Amazon Cognito identity provider when invoked
--   through the AWS Mobile SDK.
[requestCognitoIdentity] :: GenRequest a -> !ByteString

-- | The ARN requested. This can be different in each invoke that executes
--   the same version.
[requestARN] :: GenRequest a -> !ByteString

-- | Function execution deadline counted in milliseconds since the Unix
--   epoch.
[requestDeadline] :: GenRequest a -> !Deadline

-- | Opaque request id
data RequestId

-- | Get time remaining (milliseconds).
getTimeRemaining :: GenRequest a -> IO Int64

-- | Create JSON response.
jsonResponse :: ToJSON a => a -> Response
jsonMediaType :: MediaType
instance GHC.Show.Show AWS.Lambda.RuntimeAPI.Response
instance Data.Traversable.Traversable AWS.Lambda.RuntimeAPI.GenRequest
instance Data.Foldable.Foldable AWS.Lambda.RuntimeAPI.GenRequest
instance GHC.Base.Functor AWS.Lambda.RuntimeAPI.GenRequest
instance GHC.Show.Show a => GHC.Show.Show (AWS.Lambda.RuntimeAPI.GenRequest a)
instance GHC.Show.Show AWS.Lambda.RuntimeAPI.Deadline
instance GHC.Show.Show AWS.Lambda.RuntimeAPI.RequestId
instance Control.DeepSeq.NFData AWS.Lambda.RuntimeAPI.HttpRes
instance Control.DeepSeq.NFData AWS.Lambda.RuntimeAPI.Response


-- | Utility to package lambda
--   
--   Example usage, you need to run it on AWS Linux (e.g. Docker, see
--   <a>Dockerfile</a>) with <tt>GHC</tt>, <tt>cabal</tt> and
--   <tt>cabal-plan</tt> available.
--   
--   <pre>
--   module Main (main) where
--   
--   import AWS.Lambda.RuntimeAPI.Package (<a>defaultConf</a>, <a>packageAwsLambda</a>)
--   import Data.Char                     (isSpace)
--   
--   import qualified Data.ByteString.Lazy as LBS
--   import qualified System.Process       as P
--   
--   main :: IO ()
--   main = do
--       -- Build the executable
--       let exe = "example-lambda"
--       P.callProcess "cabal" ["new-build", exe]
--   
--       -- Find the build artifact
--       exePath &lt;- trim &lt;$&gt; P.readProcess "cabal-plan" [ "list-bin", exe ] ""
--       putStrLn $ "Packaging executable: " ++ exePath
--   
--       -- Package it
--       zipFile &lt;- <a>packageAwsLambda</a> <a>defaultConf</a> exePath
--       LBS.writeFile "example-lambda.zip" zipFile
--     where
--       trim = dropWhile isSpace . reverse . dropWhile isSpace . reverse
--   </pre>
--   
--   Given such environment, we can build an example lambda function:
--   
--   <pre>
--   % docker run -ti --rm -v $(pwd):<i>work -w </i>work amazonlinux-with-ghc
--   
--   % cabal new-update
--   % cabal new-build
--   % runghc package-example-lambda.hs
--   </pre>
--   
--   The resulting <tt>example-lambda.zip</tt> is ready to be uploaded!
module AWS.Lambda.RuntimeAPI.Package

-- | Package AWS Lambda executable.
packageAwsLambda :: Conf -> FilePath -> IO ByteString
data Conf
Conf :: ![String] -> !FilePath -> IO ByteString -> Conf

-- | library names we know surely need to be packaged
[_confAdditionalLibs] :: Conf -> ![String]

-- | function to read file from filesystem
[_confReadFile] :: Conf -> !FilePath -> IO ByteString
defaultConf :: Conf
confAdditionalLibs :: Functor f => ([String] -> f [String]) -> Conf -> f Conf
confReadFile :: Functor f => ((FilePath -> IO ByteString) -> f (FilePath -> IO ByteString)) -> Conf -> f Conf

-- | Run <tt>ldd</tt> on given <tt>filepath</tt>, return <tt>.so</tt>
--   files.
findExtraLibs :: [String] -> FilePath -> IO [FilePath]