fix typings on updated api success response

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)
 
+## [1.2.1]  (2019-10-06)
+
+### Fixed
+
+- Added correct type definitions for new API success response method
+
 ## [1.2.0]  (2019-10-06)
 
 ### Added

examples/ts/app/api.ts

@@ -3,7 +3,15 @@ import 'source-map-support/register';
 
 export const handler = api(async ({ event, success, error }) => {
   try {
-    return success(event);
+    const replacer = (key, value) => {
+      switch (key) {
+        case 'prop-to-ignore':
+          return undefined;
+        default:
+          return value;
+      }
+    };
+    return success(event, replacer);
   } catch (err) {
     return error(err);
   }

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@manwaring/lambda-wrapper",
   "description": "A lambda handler wrapper to abstract common functionality and provide useful defaults",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "scripts": {
     "publish-please-dry-run": "publish-please --dry-run",
     "publish-please": "publish-please",

package.json

@@ -35,7 +35,7 @@ export interface ApiSignature {
   headers: { [name: string]: string }; // header payload as key-value pairs if exists (otherwise null)
   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)
-  success(payload?: any): void; // returns 200 status with payload
+  success(payload?: any, replacer?: (this: any, key: string, value: any) => any): void; // returns 200 status with payload
   invalid(errors?: string[]): void; // returns 400 status with errors in payload
   redirect(url: string): void; // returns 302 redirect with new url
   error(error?: any): void; // returns 500 status with error and original request payload