add support for httpapi events

Author: manwaring

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [3.7.0]  (2020-08-03)
+
+### Added
+
+- Support for HTTP API 2.0 payloads
+
 ## [3.6.3]  (2020-06-21)
 
 ### Fixed
@@ -247,6 +253,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/),
 - Update older libraries
 - Now publish from Git tags instead of master pushes
 
+[3.7.0]: https://github.com/manwaring/lambda-wrapper/compare/v3.6.3...v3.7.0
 [3.6.3]: https://github.com/manwaring/lambda-wrapper/compare/v3.6.2...v3.6.3
 [3.6.2]: https://github.com/manwaring/lambda-wrapper/compare/v3.6.1...v3.6.2
 [3.6.1]: https://github.com/manwaring/lambda-wrapper/compare/v3.6.0...v3.6.1

README.md

@@ -36,6 +36,7 @@
    - [Optional configuration](#optional-configuration)
 1. [Supported events](#supported-events)
    - [API Gateway](#api-gateway)
+   - [API Gateway HTTP API](#api-gateway-http-api)
    - [CloudFormation Custom Resource](#cloudformation-custom-resource)
    - [DynamoDB Stream](#dynamodb-stream)
    - [Lambda Authorizer](#lambda-authorizer)
@@ -74,6 +75,7 @@ If you want each invocation to be tagged with the AWS region, environment/, and
 All of the events bellow have a corresponding wrapper which provides a deconstructed method signature exposing parsed/unmarshalled request parameters and helper response methods.
 
 1. [API Gateway](#api-gateway) with support for cors headers and 200, 302, 400, and 500 responses
+1. [API Gateway HTTP API](#api-gateway-http-api) with support for cors headers and 200, 302, 400, and 500 responses
 1. [CloudFormation Custom Resource](#cloudformation-custom-resource) with support for CloudFormation successes and failures
 1. [DynamoDB Stream](#dynamodb-stream) with support for success and failure responses
 1. [Lambda Authorizer](#lambda-authorizer) with support for creating access policies for successfully authorized requests
@@ -151,7 +153,55 @@ interface ApiResponse {
 }
 ```
 
-\*Note that each callback helper functions (success, invalid, redirect, error) includes CORS-enabling header information
+\*Note that each callback helper function (success, invalid, redirect, error) includes CORS-enabling header information
+
+## API Gateway HTTP API
+
+### Sample implementation
+
+```ts
+import { httpApi } from '@manwaring/lambda-wrapper';
+import { CustomInterface } from './custom-interface';
+
+// By passing in CustomInterface as a generic the async method signature will correctly identify newVersions as an array of CustomInterface, making TypeScript development easier (note that the generic is not required in JavaScript projects)
+export const handler = httpApi<CustomInterface>(async ({ body, path, success, error }) => {
+  try {
+    const { pathParam1, pathParam2 } = path;
+    const results = await doSomething(body, pathParam1, pathParam2);
+    return success(results);
+  } catch (err) {
+    return error(err);
+  }
+});
+```
+
+### Properties and methods available on wrapper signature
+
+```ts
+export interface HttpApiSignature<T = any> {
+  event: HttpApiEvent; // original event from https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format
+  body: T; // JSON parsed body payload if exists (otherwise undefined)
+  path: { [name: string]: string }; // path param payload as key-value pairs if exists (otherwise undefined)
+  query: { [name: string]: string }; // query param payload as key-value pairs if exists (otherwise undefined)
+  headers: { [name: string]: string }; // header payload as key-value pairs if exists (otherwise undefined)
+  testRequest: boolean; // indicates if this is a test request - looks for a header matching process.env.TEST_REQUEST_HEADER (dynamic from application) or 'Test-Request' (default)
+  auth: any; // auth context from custom authorizer if exists (otherwise undefined)
+  success(payload?: any, replacer?: (this: any, key: string, value: any) => any): ApiResponse; // returns 200 status code with optional payload as body
+  invalid(errors?: string[]): ApiResponse; // returns 400 status code with optional errors as body
+  notFound(message?: string): ApiResponse; // returns 404 status code with optional message as body
+  notAuthorized(message?: string): ApiResponse; // returns 403 status code with optional message as body
+  redirect(url: string): ApiResponse; // returns 302 status code (redirect) with new url
+  error(error?: any): ApiResponse; // returns 500 status code with optional error as body
+}
+
+interface ApiResponse {
+  statusCode: number;
+  headers: { [name: string]: string | boolean };
+  body?: string;
+}
+```
+
+\*Note that each callback helper function (success, invalid, redirect, error) includes CORS-enabling header information
 
 ## CloudFormation Custom Resource