add missing 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)
 
+## [4.3.0]  (2020-11-13)
+
+### Added
+
+- Added rawQueryString as parsed param to http api wrapper
+
 ## [4.2.0]  (2020-11-13)
 
 ### Added
@@ -323,6 +329,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.3.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.2.0...v4.3.0
 [4.2.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.1.1...v4.2.0
 [4.1.1]: https://github.com/manwaring/lambda-wrapper/compare/v4.1.0...v4.1.1
 [4.1.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.6...v4.1.0

README.md

@@ -735,6 +735,7 @@ export interface HttpApiSignature<T = any> {
   rawPath: string; // the endpoint path used to invoke this Lambda
   path: { [name: string]: string }; // path params as key-value pairs
   query: { [name: string]: string }; // query params as key-value pairs
+  rawQueryString: string // the raw query string from the request
   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

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": "4.2.0",
+  "version": "4.3.0",
   "scripts": {
     "publish-please-dry-run": "publish-please --dry-run",
     "publish-please": "publish-please",

package.json

@@ -59,15 +59,19 @@ describe('Http API request parsing', () => {
       body: JSON.stringify({ hello: 'world' }),
       rawPath: '/api/v1/nouns/id124',
       pathParameters: { proxy: 'not today' },
-      queryStringParameters: { name: 'a test' },
+      rawQueryString: 'name=atest',
+      queryStringParameters: { name: 'atest' },
       headers: { 'content-type': 'application/json', 'Test-Request': 'true' },
     });
-    const { body, path, rawPath, query, auth, headers, testRequest } = new Request(event).getProperties();
+    const { body, path, rawPath, query, rawQueryString, auth, headers, testRequest } = new Request(
+      event
+    ).getProperties();
 
     expect(body).toEqual({ hello: 'world' });
     expect(path['proxy']).toEqual(event.pathParameters.proxy);
     expect(rawPath).toEqual(event.rawPath);
     expect(query['name']).toEqual(event.queryStringParameters.name);
+    expect(rawQueryString).toEqual(event.rawQueryString);
     expect(headers['content-type']).toEqual('application/json');
     expect(testRequest).toEqual(true);
     expect(auth).toBeTruthy();
@@ -79,13 +83,17 @@ describe('Http API request parsing', () => {
     delete event.rawPath;
     delete event.headers;
     delete event.pathParameters;
+    delete event.rawQueryString;
     delete event.queryStringParameters;
-    const { body, path, rawPath, query, auth, headers, testRequest } = new Request(event).getProperties();
+    const { body, path, rawPath, query, rawQueryString, auth, headers, testRequest } = new Request(
+      event
+    ).getProperties();
 
     expect(body).toBeFalsy();
     expect(path).toBeFalsy();
     expect(rawPath).toBeFalsy();
     expect(query).toBeFalsy();
+    expect(rawQueryString).toBeFalsy();
     expect(auth).toBeTruthy();
     expect(headers).toBeFalsy();
     expect(testRequest).toBeFalsy();

src/api/v2-http/parser.test.ts

@@ -7,17 +7,27 @@ const metrics = new Metrics('API Gateway');
 export class Request {
   constructor(private event: HttpApiEvent) {}
 
-  getProperties(): any {
+  getProperties(): {
+    body: any;
+    path: { [name: string]: string };
+    rawPath: string;
+    query: { [name: string]: string };
+    rawQueryString: string;
+    headers: { [name: string]: string };
+    testRequest: boolean;
+    auth: any;
+  } {
     const event = this.event;
     const path = event.pathParameters || undefined;
     const rawPath = event.rawPath || undefined;
     const query = event.queryStringParameters || undefined;
+    const rawQueryString = event.rawQueryString || undefined;
     const auth = this.getAuth();
     const headers = event.headers || undefined;
     const body = new Body(event.body, headers).getParsedBody();
     const TEST_REQUEST_HEADER = process.env.TEST_REQUEST_HEADER || 'Test-Request';
     const testRequest = headers && headers[TEST_REQUEST_HEADER] ? JSON.parse(headers[TEST_REQUEST_HEADER]) : false;
-    const parsed = { body, path, rawPath, query, auth, headers, testRequest };
+    const parsed = { body, path, rawPath, query, rawQueryString, auth, headers, testRequest };
     metrics.common(parsed, event);
     return parsed;
   }

src/api/v2-http/parser.ts

@@ -20,13 +20,16 @@ export function httpApi<T = any>(
   customHandler: (props: HttpApiSignature<T>) => any
 ): (event: HttpApiEvent, context: Context, callback: Callback) => any {
   return function handler(event: HttpApiEvent) {
-    const { body, path, rawPath, query, auth, headers, testRequest } = new Request(event).getProperties();
+    const { body, path, rawPath, query, rawQueryString, auth, headers, testRequest } = new Request(
+      event
+    ).getProperties();
     const signature: HttpApiSignature<T> = {
       event,
       body,
       path,
       rawPath,
       query,
+      rawQueryString,
       headers,
       testRequest,
       auth,
@@ -48,6 +51,7 @@ export interface HttpApiSignature<T = any> {
   path: { [name: string]: string };
   rawPath: string;
   query: { [name: string]: string };
+  rawQueryString: string;
   headers: { [name: string]: string };
   testRequest: boolean;
   auth: any;