.

Author: naorpeled

README.md

@@ -39,14 +39,14 @@ For a full tutorial see [How To: Build a Serverless API with Serverless, AWS Lam
 Lambda API includes comprehensive TypeScript definitions out of the box. You can leverage type safety across your entire API:
 
 ```typescript
-import { 
-  API, 
-  Request, 
+import {
+  API,
+  Request,
   Response,
   SourceAgnosticHandler,
   SourceAgnosticMiddleware,
   isApiGatewayContext,
-  isAlbContext
+  isAlbContext,
 } from 'lambda-api';
 
 // Define your response type
@@ -63,18 +63,18 @@ const api = new API();
 const handler: SourceAgnosticHandler<UserResponse> = (req, res) => {
   // Common properties are always available
   console.log(req.method, req.path);
-  
+
   // Type-safe access to source-specific features
   if (isApiGatewayContext(req.requestContext)) {
     console.log(req.requestContext.identity);
   } else if (isAlbContext(req.requestContext)) {
     console.log(req.requestContext.elb);
   }
-  
+
   res.json({
     id: '1',
     name: 'John',
-    email: '[email protected]'
+    email: '[email protected]',
   });
 };
 
@@ -89,29 +89,37 @@ const middleware: SourceAgnosticMiddleware = (req, res, next) => {
 api.get('/users', middleware, handler);
 
 // For source-specific handlers, you can specify the context type
-interface UserQuery { fields: string }
-interface UserParams { id: string }
-interface UserBody { name: string; email: string }
+interface UserQuery {
+  fields: string;
+}
+interface UserParams {
+  id: string;
+}
+interface UserBody {
+  name: string;
+  email: string;
+}
 
 api.post<UserResponse, APIGatewayContext, UserQuery, UserParams, UserBody>(
   '/users',
   (req, res) => {
     // Full type safety for:
-    req.query.fields;     // UserQuery
-    req.params.id;        // UserParams
-    req.body.name;        // UserBody
-    req.requestContext;   // APIGatewayContext
-    
+    req.query.fields; // UserQuery
+    req.params.id; // UserParams
+    req.body.name; // UserBody
+    req.requestContext; // APIGatewayContext
+
     res.json({
       id: '1',
       name: req.body.name,
-      email: req.body.email
+      email: req.body.email,
     });
   }
 );
 ```
 
 Key TypeScript Features:
+
 - Source-agnostic types that work with any Lambda trigger
 - Type guards for safe context type checking
 - Full type inference for request and response objects
@@ -127,13 +135,13 @@ Key TypeScript Features:
 Lambda API provides type guards to safely work with different request sources:
 
 ```typescript
-import { 
+import {
   isApiGatewayContext,
-  isApiGatewayV2Context, 
+  isApiGatewayV2Context,
   isAlbContext,
   isApiGatewayRequest,
   isApiGatewayV2Request,
-  isAlbRequest
+  isAlbRequest,
 } from 'lambda-api';
 
 // Check request context type
@@ -154,11 +162,11 @@ if (isApiGatewayRequest(req)) {
 Lambda API provides type-safe support for different AWS Lambda triggers. You can write source-specific handlers or use source-agnostic handlers that work with any trigger:
 
 ```typescript
-import { 
-  isApiGatewayContext, 
-  isApiGatewayV2Context, 
+import {
+  isApiGatewayContext,
+  isApiGatewayV2Context,
   isAlbContext,
-  SourceAgnosticHandler 
+  SourceAgnosticHandler,
 } from 'lambda-api';
 
 // Source-specific handler
@@ -177,14 +185,15 @@ const handler: SourceAgnosticHandler = (req, res) => {
   } else if (isAlbContext(req.requestContext)) {
     console.log(req.requestContext.elb);
   }
-  
+
   res.json({ status: 'ok' });
 };
 
 api.get('/any', handler);
 ```
 
 Key features for handling multiple sources:
+
 - Type guards for safe context type checking
 - Source-agnostic types that work with any trigger
 - Full type safety for source-specific properties
@@ -1661,15 +1670,17 @@ declare module 'lambda-api' {
   }
 }
 
-function hasUser(req: Request): req is Request & { user: { id: string; roles: string[]; email: string; } } {
+function hasUser(
+  req: Request
+): req is Request & { user: { id: string; roles: string[]; email: string } } {
   return 'user' in req && req.user !== undefined;
 }
 
 const authMiddleware: Middleware = (req, res, next) => {
   req.user = {
     id: '123',
     roles: ['admin'],
-    email: '[email protected]'
+    email: '[email protected]',
   };
   next();
 };
@@ -1695,7 +1706,7 @@ const responseEnhancer: Middleware = (req, res, next) => {
   res.sendWithTimestamp = (data: any) => {
     res.json({
       ...data,
-      timestamp: Date.now()
+      timestamp: Date.now(),
     });
   };
   next();
@@ -1725,7 +1736,7 @@ const authMiddleware: Middleware = (req, res, next) => {
     userId: '123',
     roles: ['user'],
     type: 'Bearer',
-    value: 'token123'
+    value: 'token123',
   };
   next();
 };
@@ -1743,13 +1754,12 @@ interface QueryParams {
   offset?: string;
 }
 
-api.get<UserResponse, APIGatewayContext, QueryParams>(
-  '/users',
-  (req, res) => {
-    const { limit, offset } = req.query;
-    res.json({ /* ... */ });
-  }
-);
+api.get<UserResponse, APIGatewayContext, QueryParams>('/users', (req, res) => {
+  const { limit, offset } = req.query;
+  res.json({
+    /* ... */
+  });
+});
 
 interface CreateUserBody {
   name: string;
@@ -1760,7 +1770,9 @@ api.post<UserResponse, APIGatewayContext, never, never, CreateUserBody>(
   '/users',
   (req, res) => {
     const { name, email } = req.body;
-    res.json({ /* ... */ });
+    res.json({
+      /* ... */
+    });
   }
 );
 
@@ -1779,7 +1791,11 @@ api.get('/protected', withUser(handler));
 ## Handling Multiple Request Sources
 
 ```typescript
-import { isApiGatewayContext, isApiGatewayV2Context, isAlbContext } from 'lambda-api';
+import {
+  isApiGatewayContext,
+  isApiGatewayV2Context,
+  isAlbContext,
+} from 'lambda-api';
 
 api.get<Response, APIGatewayRequestContext>('/api-gateway', (req, res) => {
   console.log(req.requestContext.identity);
@@ -1797,4 +1813,3 @@ api.get('/any', (req, res) => {
   }
 });
 ```
-

index.js

@@ -12,7 +12,11 @@ const LOGGER = require('./lib/logger');
 const S3 = () => require('./lib/s3-service');
 const prettyPrint = require('./lib/prettyPrint');
 const { ConfigurationError } = require('./lib/errors');
-const { isApiGatewayContext, isApiGatewayV2Context, isAlbContext } = require('./lib/typeguards');
+const {
+  isApiGatewayContext,
+  isApiGatewayV2Context,
+  isAlbContext,
+} = require('./lib/typeguards');
 
 class API {
   constructor(props) {
@@ -43,8 +47,8 @@ class API {
         : {};
     this._compression =
       props &&
-        (typeof props.compression === 'boolean' ||
-          Array.isArray(props.compression))
+      (typeof props.compression === 'boolean' ||
+        Array.isArray(props.compression))
         ? props.compression
         : false;
 
@@ -85,7 +89,7 @@ class API {
     this._app = {};
 
     // Executed after the callback
-    this._finally = () => { };
+    this._finally = () => {};
 
     // Global error status (used for response parsing errors)
     this._errorStatus = 500;
@@ -214,8 +218,8 @@ class API {
               stack: _stack['m'][method]
                 ? _stack['m'][method].concat(stack)
                 : _stack['*'][method]
-                  ? _stack['*'][method].concat(stack)
-                  : stack,
+                ? _stack['*'][method].concat(stack)
+                : stack,
               // inherited: _stack[method] ? _stack[method] : [],
               route: '/' + parsedPath.join('/'),
               path: '/' + this._prefix.concat(parsedPath).join('/'),
@@ -451,8 +455,8 @@ class API {
       typeof args[0] === 'string'
         ? Array.of(args.shift())
         : Array.isArray(args[0])
-          ? args.shift()
-          : ['/*'];
+        ? args.shift()
+        : ['/*'];
 
     // Init middleware stack
     let middleware = [];

lib/typeguards.js

@@ -1,19 +1,19 @@
 'use strict';
 
 const isApiGatewayContext = (context) => {
-    return 'identity' in context;
+  return 'identity' in context;
 };
 
 const isApiGatewayV2Context = (context) => {
-    return 'http' in context;
+  return 'http' in context;
 };
 
 const isAlbContext = (context) => {
-    return 'elb' in context;
+  return 'elb' in context;
 };
 
 module.exports = {
-    isApiGatewayContext,
-    isApiGatewayV2Context,
-    isAlbContext
-}; 
+  isApiGatewayContext,
+  isApiGatewayV2Context,
+  isAlbContext,
+};