add support for websocket connections

Author: manwaring

.gitignore

@@ -62,3 +62,5 @@ typings/
 
 # next.js build output
 .next
+
+.vscode

CHANGELOG.md

@@ -4,6 +4,16 @@ 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.6.0]  (2020-06-21)
+
+### Added
+
+- Add support for Websocket connections
+
+### Updated
+
+- Updated all libraries to latest
+
 ## [3.5.0]  (2020-05-10)
 
 ### Changed
@@ -219,6 +229,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.6.0]: https://github.com/manwaring/lambda-wrapper/compare/v3.5.0...v3.6.0
 [3.5.0]: https://github.com/manwaring/lambda-wrapper/compare/v3.4.0...v3.5.0
 [3.4.0]: https://github.com/manwaring/lambda-wrapper/compare/v3.3.3...v3.4.0
 [3.3.3]: https://github.com/manwaring/lambda-wrapper/compare/v3.3.1...v3.3.3

README.md

@@ -103,22 +103,47 @@ export const handler = api<CustomInterface>(async ({ body, path, success, error
 ### Properties and methods available on wrapper signature
 
 ```ts
-export interface ApiSignature<T> {
+export interface ApiSignature<T = any> {
   event: APIGatewayEvent; // original event
   body: T; // JSON parsed body payload if exists (otherwise undefined)
+  requestContext: WebsocketRequestContext; // websocket connection payload
   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 null)
+  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 401 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
 }
 
+export interface WebsocketRequestContext {
+  accountId: string;
+  apiId: string;
+  connectedAt?: number;
+  connectionId?: string;
+  domainName?: string;
+  domainPrefix?: string;
+  eventType?: string;
+  extendedRequestId?: string;
+  protocol: string;
+  httpMethod: string;
+  identity: APIGatewayEventIdentity;
+  messageDirection?: string;
+  messageId?: string | null;
+  path: string;
+  stage: string;
+  requestId: string;
+  requestTime?: string;
+  requestTimeEpoch: number;
+  resourceId: string;
+  resourcePath: string;
+  routeKey?: string;
+}
+
 interface ApiResponse {
   statusCode: number;
   headers: { [name: string]: string | boolean };