rename websocket property on signature

Author: manwaring

src/api/parser.ts

@@ -9,7 +9,7 @@ export class Request {
 
   getProperties(): any {
     const event = this.event;
-    const requestContext = event.requestContext ? event.requestContext : undefined;
+    const websocket = event.requestContext ? event.requestContext : undefined;
     const path = event.pathParameters ? event.pathParameters : undefined;
     const query = event.queryStringParameters ? event.queryStringParameters : undefined;
     const auth = this.getAuth();
@@ -18,7 +18,7 @@ export class Request {
     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;
     metrics.common({ body, path, query, auth, headers, testRequest });
-    return { body, requestContext, path, query, auth, headers, testRequest };
+    return { body, websocket, path, query, auth, headers, testRequest };
   }
 
   private getAuth() {

src/api/wrapper.test.ts

@@ -31,7 +31,7 @@ describe('API wrapper', () => {
     // @ts-ignore
     function custom({
       event,
-      requestContext,
+      websocket,
       body,
       path,
       query,
@@ -46,7 +46,7 @@ describe('API wrapper', () => {
       error,
     }: ApiSignature) {
       expect(event).toEqual(requestEvent);
-      expect(requestContext.connectionId).toEqual('abc-123');
+      expect(websocket.connectionId).toEqual('abc-123');
       expect(body).toEqual({ hello: 'world' });
       expect(path).toEqual({ proxy: 'not today' });
       expect(query).toEqual({ name: 'a test' });
@@ -71,7 +71,7 @@ describe('API wrapper', () => {
     }
     function custom<CustomType>({
       event,
-      requestContext,
+      websocket,
       body,
       path,
       query,
@@ -86,7 +86,7 @@ describe('API wrapper', () => {
       error,
     }: ApiSignature<CustomType>) {
       expect(event).toEqual(requestEvent);
-      expect(requestContext.connectionId).toEqual('abc-123');
+      expect(websocket.connectionId).toEqual('abc-123');
       expect(body).toEqual({ hello: 'world' });
       expect(path).toEqual({ proxy: 'not today' });
       expect(query).toEqual({ name: 'a test' });

src/api/wrapper.ts

@@ -12,11 +12,11 @@ export function api<T = any>(
   custom: (props: ApiSignature<T>) => any
 ): (event: APIGatewayEvent, context: Context, callback: Callback) => any {
   return function handler(event: APIGatewayEvent) {
-    const { body, requestContext, path, query, auth, headers, testRequest } = new Request(event).getProperties();
+    const { body, websocket, path, query, auth, headers, testRequest } = new Request(event).getProperties();
     const signature: ApiSignature<T> = {
       event,
       body,
-      requestContext,
+      websocket,
       path,
       query,
       headers,
@@ -36,7 +36,7 @@ export function api<T = any>(
 export interface ApiSignature<T = any> {
   event: APIGatewayEvent; // original event
   body: T; // JSON parsed body payload if exists (otherwise undefined)
-  requestContext: WebsocketRequestContext; // websocket connection payload
+  websocket: WebsocketRequest; // 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)
@@ -50,7 +50,7 @@ export interface ApiSignature<T = any> {
   error(error?: any): ApiResponse; // returns 500 status code with optional error as body
 }
 
-export interface WebsocketRequestContext {
+export interface WebsocketRequest {
   accountId: string;
   apiId: string;
   connectedAt?: number;