@medial/lambda/README.md

A middleware for AWS lambda

# @medial/lambda
[![Build Status](https://travis-ci.com/medial-io/lambda.svg?branch=master)](https://travis-ci.com/github/medial-io/lambda)
[![codecov](https://codecov.io/gh/medial-io/lambda/branch/master/graph/badge.svg)](https://codecov.io/gh/medial-io/lambda)
[![Known Vulnerabilities](https://snyk.io/test/github/medial-io/lambda/badge.svg?targetFile=package.json)](https://snyk.io/test/github/medial-io/lambda?targetFile=package.json)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/medial-io/lambda.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/medial-io/lambda/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/medial-io/lambda.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/medial-io/lambda/context:javascript)

# A wrapper for AWS Lambda 
A wrapper to help build AWS Lambda backed HTTP services.

Features
 - Validation via [Joi](https://github.com/hapijs/joi)
    - Headers
    - Path Params
    - Query Params
    - Payload
 - Error responses via [Boom](https://github.com/hapijs/boom)
 - handles complexities of dealing with lambda functions (For example: multiple values for the same key in queryParams)

**Please checkout the [full example](https://github.com/medial-io/lambda-example)**

**Inspired by the [hapi](https://hapi.dev/) framework.**

## Example

Medial Handler Object

```
const Lambda = require('@medial/lambda');
const Boom = require('@hapi/boom');
const Joi = require('@hapi/joi');


exports.get = Lambda.define({
  validate: {
    query: Joi.object().keys({
      world: Joi.string().default('world')
    })
  },
  handler: async function(request, h) {
    const world = request.query.world;

    return {hello: world};
  }
});
```
`exports.get` is now a AWS Lambda function. Once this function is configured for HTTP access via the AWS API Gateway - when invoked, it will return ```{"hello": "world"}``` with a response code of `200`.

You can also invoke the lambda from another lambda. The response will look like this: 
```
{
  multiValueHeaders: {},
  statusCode: 200,
  body: '{"hello": "world"}' // this is stringifyed object 
}
```
## Working example
Deploy the example to AWS and/or run it locally with swagger documentation

**[A full example](https://github.com/medial-io/lambda-example)**

# Documentation
 - [Handler API](docs/HANDLER-API.md)
 - [Client API](docs/CLIENT-API.md)