update response interface

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)
 
+## [4.0.1]  (2020-08-11)
+
+### Fixed
+
+- Updated api response interfaces to indicate optional vs required params
+
 ## [4.0.0]  (2020-08-11)
 
 ### Changed
@@ -259,6 +265,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
 
+[4.0.1]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/manwaring/lambda-wrapper/compare/v3.7.0...v4.0.0
 [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

README.md

@@ -123,12 +123,12 @@ export interface ApiSignature<T = any> {
   headers: { [name: string]: string }; // headers as key-value pairs
   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
-  success(paramaters: ResponseParameters): ApiResponse;
-  invalid(paramaters: ResponseParameters): ApiResponse;
-  notFound(paramaters: ResponseParameters): ApiResponse;
-  notAuthorized(paramaters: ResponseParameters): ApiResponse;
-  redirect(parameters: RedirectParameters): ApiResponse;
-  error(parameters: ErrorParameters): ApiResponse;
+  success(params?: ResponseParameters): ApiResponse;
+  invalid(params?: ResponseParameters): ApiResponse;
+  notFound(params?: ResponseParameters): ApiResponse;
+  notAuthorized(params?: ResponseParameters): ApiResponse;
+  redirect(params: RedirectParameters): ApiResponse;
+  error(params?: ErrorParameters): ApiResponse;
 }
 ```
 
@@ -615,12 +615,12 @@ export interface HttpApiSignature<T = any> {
   headers: { [name: string]: string }; // headers as key-value pairs
   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 JWT authorizer
-  success(paramaters: ResponseParameters): ApiResponse;
-  invalid(paramaters: ResponseParameters): ApiResponse;
-  notFound(paramaters: ResponseParameters): ApiResponse;
-  notAuthorized(paramaters: ResponseParameters): ApiResponse;
-  redirect(parameters: RedirectParameters): ApiResponse;
-  error(parameters: ErrorParameters): ApiResponse;
+  success(params?: ResponseParameters): ApiResponse;
+  invalid(params?: ResponseParameters): ApiResponse;
+  notFound(params?: ResponseParameters): ApiResponse;
+  notAuthorized(params?: ResponseParameters): ApiResponse;
+  redirect(params: RedirectParameters): ApiResponse;
+  error(params?: ErrorParameters): ApiResponse;
 }
 ```
 

src/api/v1/wrapper.ts

@@ -47,12 +47,12 @@ export interface ApiSignature<T = any> {
   headers: { [name: string]: string };
   testRequest: boolean;
   auth: any;
-  success(params: ResponseParameters): ApiResponse;
-  invalid(params: ResponseParameters): ApiResponse;
-  notFound(params: ResponseParameters): ApiResponse;
-  notAuthorized(params: ResponseParameters): ApiResponse;
+  success(params?: ResponseParameters): ApiResponse;
+  invalid(params?: ResponseParameters): ApiResponse;
+  notFound(params?: ResponseParameters): ApiResponse;
+  notAuthorized(params?: ResponseParameters): ApiResponse;
   redirect(params: RedirectParameters): ApiResponse;
-  error(params: ErrorParameters): ApiResponse;
+  error(params?: ErrorParameters): ApiResponse;
 }
 
 export interface WebsocketRequest {

src/api/v2-http/wrapper.ts

@@ -46,10 +46,10 @@ export interface HttpApiSignature<T = any> {
   headers: { [name: string]: string };
   testRequest: boolean;
   auth: any;
-  success(params: ResponseParameters): ApiResponse;
-  invalid(params: ResponseParameters): ApiResponse;
-  notFound(params: ResponseParameters): ApiResponse;
-  notAuthorized(params: ResponseParameters): ApiResponse;
+  success(params?: ResponseParameters): ApiResponse;
+  invalid(params?: ResponseParameters): ApiResponse;
+  notFound(params?: ResponseParameters): ApiResponse;
+  notAuthorized(params?: ResponseParameters): ApiResponse;
   redirect(params: RedirectParameters): ApiResponse;
-  error(params: ErrorParameters): ApiResponse;
+  error(params?: ErrorParameters): ApiResponse;
 }