@middy/http-router 5.0.0-alpha.0 → 5.0.0-alpha.2

package/README.md

@@ -19,8 +19,9 @@
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.d.ts

@@ -5,21 +5,13 @@ import {
   APIGatewayProxyEvent,
   APIGatewayProxyEventV2,
   APIGatewayProxyResult,
+  APIGatewayProxyResultV2,
   Handler as LambdaHandler
 } from 'aws-lambda'
 
-export enum Method {
-  Get = 'GET',
-  Post = 'POST',
-  Put = 'PUT',
-  Patch = 'PATCH',
-  Delete = 'DELETE',
-  Options = 'OPTIONS',
-  Head = 'HEAD',
-  Any = 'ANY'
-}
+export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'ANY'
 
-type TResult = ALBResult | APIGatewayProxyResult
+type TResult = ALBResult | APIGatewayProxyResult | APIGatewayProxyResultV2
 
 export interface Route<TEvent> {
   method: Method

package/index.js

@@ -4,28 +4,43 @@ const httpRouteHandler = (routes)=>{
     const routesDynamic = {};
     const enumMethods = methods.concat('ANY');
     for (const route of routes){
-        let { method , path , handler  } = route;
+        let { method, path, handler } = route;
+        // Prevents `routesType[method][path] = handler` from flagging: This assignment may alter Object.prototype if a malicious '__proto__' string is injected from library input.
         if (!enumMethods.includes(method)) {
-            throw new Error('[http-router] Method not allowed');
+            throw new Error('Method not allowed', {
+                cause: {
+                    package: '@middy/http-router'
+                }
+            });
         }
+        // remove trailing slash, but not if it's the first one
         if (path.endsWith('/') && path !== '/') {
             path = path.substr(0, path.length - 1);
         }
+        // Static
         if (path.indexOf('{') < 0) {
             attachStaticRoute(method, path, handler, routesStatic);
             continue;
         }
+        // Dynamic
         attachDynamicRoute(method, path, handler, routesDynamic);
     }
     return (event, context, abort)=>{
-        const { method , path  } = getVersionRoute[event.version ?? '1.0']?.(event);
+        const { method, path } = getVersionRoute[pickVersion(event)]?.(event);
         if (!method) {
-            throw new Error('[http-router] Unknown http event format');
+            throw new Error('Unknown http event format', {
+                cause: {
+                    package: '@middy/http-router',
+                    data: event
+                }
+            });
         }
+        // Static
         const handler = routesStatic[method]?.[path];
         if (typeof handler !== 'undefined') {
             return handler(event, context, abort);
         }
+        // Dynamic
         for (const route of routesDynamic[method] ?? []){
             const match = path.match(route.path);
             if (match) {
@@ -36,7 +51,13 @@ const httpRouteHandler = (routes)=>{
                 return route.handler(event, context, abort);
             }
         }
-        throw createError(404, 'Route does not exist');
+        // Not Found
+        throw createError(404, 'Route does not exist', {
+            cause: {
+                pacakge: '@middy/http-router',
+                data: path
+            }
+        });
     };
 };
 const regexpDynamicWildcards = /\/\{(proxy)\+\}$/;
@@ -49,7 +70,8 @@ const methods = [
     'DELETE',
     'OPTIONS',
     'HEAD'
-];
+] // ANY excluded by design
+;
 const attachStaticRoute = (method, path, handler, routesType)=>{
     if (method === 'ANY') {
         for (const method of methods){
@@ -61,7 +83,8 @@ const attachStaticRoute = (method, path, handler, routesType)=>{
         routesType[method] = {};
     }
     routesType[method][path] = handler;
-    routesType[method][path + '/'] = handler;
+    routesType[method][path + '/'] = handler // Optional `/`
+    ;
 };
 const attachDynamicRoute = (method, path, handler, routesType)=>{
     if (method === 'ANY') {
@@ -74,12 +97,17 @@ const attachDynamicRoute = (method, path, handler, routesType)=>{
         routesType[method] = [];
     }
     path = path.replace(regexpDynamicWildcards, '/?(?<$1>.*)').replace(regexpDynamicParameters, '/(?<$1>[^/]+)');
-    path = new RegExp(`^${path}/?$`);
+    path = new RegExp(`^${path}/?$`) // Adds in optional `/`
+    ;
     routesType[method].push({
         path,
         handler
     });
 };
+const pickVersion = (event)=>{
+    // '1.0' is a safer default
+    return event.version ?? (event.method ? 'vpc' : '1.0');
+};
 const getVersionRoute = {
     '1.0': (event)=>({
             method: event.httpMethod,
@@ -88,6 +116,10 @@ const getVersionRoute = {
     '2.0': (event)=>({
             method: event.requestContext.http.method,
             path: event.requestContext.http.path
+        }),
+    vpc: (event)=>({
+            method: event.method,
+            path: event.raw_path.split('?')[0]
         })
 };
 export default httpRouteHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-router",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "HTTP event router for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -66,11 +60,11 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
-    "@middy/core": "5.0.0-alpha.0",
+    "@middy/core": "5.0.0-alpha.2",
     "@types/aws-lambda": "^8.10.97"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _util = require("@middy/util");
-const httpRouteHandler = (routes)=>{
-    const routesStatic = {};
-    const routesDynamic = {};
-    const enumMethods = methods.concat('ANY');
-    for (const route of routes){
-        let { method , path , handler  } = route;
-        if (!enumMethods.includes(method)) {
-            throw new Error('[http-router] Method not allowed');
-        }
-        if (path.endsWith('/') && path !== '/') {
-            path = path.substr(0, path.length - 1);
-        }
-        if (path.indexOf('{') < 0) {
-            attachStaticRoute(method, path, handler, routesStatic);
-            continue;
-        }
-        attachDynamicRoute(method, path, handler, routesDynamic);
-    }
-    return (event, context, abort)=>{
-        const { method , path  } = getVersionRoute[event.version ?? '1.0']?.(event);
-        if (!method) {
-            throw new Error('[http-router] Unknown http event format');
-        }
-        const handler = routesStatic[method]?.[path];
-        if (typeof handler !== 'undefined') {
-            return handler(event, context, abort);
-        }
-        for (const route of routesDynamic[method] ?? []){
-            const match = path.match(route.path);
-            if (match) {
-                event.pathParameters = {
-                    ...match.groups,
-                    ...event.pathParameters
-                };
-                return route.handler(event, context, abort);
-            }
-        }
-        throw (0, _util.createError)(404, 'Route does not exist');
-    };
-};
-const regexpDynamicWildcards = /\/\{(proxy)\+\}$/;
-const regexpDynamicParameters = /\/\{([^/]+)\}/g;
-const methods = [
-    'GET',
-    'POST',
-    'PUT',
-    'PATCH',
-    'DELETE',
-    'OPTIONS',
-    'HEAD'
-];
-const attachStaticRoute = (method, path, handler, routesType)=>{
-    if (method === 'ANY') {
-        for (const method of methods){
-            attachStaticRoute(method, path, handler, routesType);
-        }
-        return;
-    }
-    if (!routesType[method]) {
-        routesType[method] = {};
-    }
-    routesType[method][path] = handler;
-    routesType[method][path + '/'] = handler;
-};
-const attachDynamicRoute = (method, path, handler, routesType)=>{
-    if (method === 'ANY') {
-        for (const method of methods){
-            attachDynamicRoute(method, path, handler, routesType);
-        }
-        return;
-    }
-    if (!routesType[method]) {
-        routesType[method] = [];
-    }
-    path = path.replace(regexpDynamicWildcards, '/?(?<$1>.*)').replace(regexpDynamicParameters, '/(?<$1>[^/]+)');
-    path = new RegExp(`^${path}/?$`);
-    routesType[method].push({
-        path,
-        handler
-    });
-};
-const getVersionRoute = {
-    '1.0': (event)=>({
-            method: event.httpMethod,
-            path: event.path
-        }),
-    '2.0': (event)=>({
-            method: event.requestContext.http.method,
-            path: event.requestContext.http.path
-        })
-};
-const _default = httpRouteHandler;
-