@middy/http-router 3.0.2 → 3.1.0-rc.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell) and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -9,8 +9,8 @@
   <a href="https://packagephobia.com/result?p=@middy/http-router">
     <img src="https://packagephobia.com/badge?p=@middy/http-router" alt="npm install size" style="max-width:100%;">
   </a>
-  <a href="https://github.com/middyjs/middy/actions">
-    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/tests.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/tests.yml/badge.svg?branch=main&event=push" alt="GitHub Actions CI status badge" style="max-width:100%;">
   </a>
   <br/>
    <a href="https://standardjs.com/">
@@ -33,6 +33,7 @@
     <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
+<p>You can read the documentation at: <a href="https://middy.js.org/docs/routers/http-router">https://middy.js.org/docs/routers/http-router</a></p>
 </div>
 
 This handler can route to requests to one of a nested hander based on `method` and `path` of an http event from API Gateway (REST or HTTP) or Elastic Load Balancer.
@@ -62,7 +63,7 @@ import middy from '@middy/core'
 import validatorMiddleware from '@middy/validator'
 
 const getHandler = middy()
-  .use(validatorMiddleware({inputSchema: {...} }))
+  .use(validatorMiddleware({eventSchema: {...} }))
   .handler((event, context) => {
     return {
       statusCode: 200,
@@ -71,7 +72,7 @@ const getHandler = middy()
   })
 
 const postHandler = middy()
-  .use(validatorMiddleware({inputSchema: {...} }))
+  .use(validatorMiddleware({eventSchema: {...} }))
   .handler((event, context) => {
     return {
       statusCode: 200,
@@ -111,7 +112,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.cjs

@@ -1,3 +1,95 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _util=require("@middy/util");const httpRouteHandler=routes=>{const routesStatic={};const routesDynamic={};const enumMethods=methods.concat("ANY");for(const route1 of routes){let{method,path,handler}=route1;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(handler!==undefined){return handler(event,context,abort)}for(const route of routesDynamic[method]??[]){if(route.path.test(path)){return route.handler(event,context,abort)}}throw(0,_util).createError(404,"Route does not exist")}};const regexpDynamicWildcards=/\/\{proxy\+\}/g;const regexpDynamicParameters=/\/\{.+\}/g;const methods=["GET","POST","PUT","PATCH","DELETE","OPTIONS"];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};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,"/?.*").replace(regexpDynamicParameters,"/.+");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})};var _default=httpRouteHandler;exports.default=_default
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+module.exports = void 0;
+var _util = require("@middy/util");
+const httpRouteHandler = (routes)=>{
+    const routesStatic = {};
+    const routesDynamic = {};
+    const enumMethods = methods.concat('ANY');
+    for (const route1 of routes){
+        let { method , path , handler  } = route1;
+        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 (handler !== undefined) {
+            return handler(event, context, abort);
+        }
+        for (const route of routesDynamic[method] ?? []){
+            if (route.path.test(path)) {
+                return route.handler(event, context, abort);
+            }
+        }
+        throw (0, _util).createError(404, 'Route does not exist');
+    };
+};
+const regexpDynamicWildcards = /\/\{proxy\+\}/g;
+const regexpDynamicParameters = /\/\{.+\}/g;
+const methods = [
+    'GET',
+    'POST',
+    'PUT',
+    'PATCH',
+    'DELETE',
+    'OPTIONS'
+];
+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;
+};
+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, '/?.*').replace(regexpDynamicParameters, '/.+');
+    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
+        })
+};
+var _default = httpRouteHandler;
+module.exports = _default;
+
 
 //# sourceMappingURL=index.cjs.map

package/index.d.ts

@@ -1,5 +1,18 @@
-// import middy from '@middy/core'
+import middy from '@middy/core'
+import {
+  APIGatewayProxyEvent,
+  APIGatewayProxyResult,
+  Handler as LambdaHandler
+} from 'aws-lambda'
 
-declare function httpRouterHandler (): any
+export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'ANY'
+
+export interface Route {
+  method: Method
+  path: string
+  handler: LambdaHandler<APIGatewayProxyEvent, APIGatewayProxyResult>
+}
+
+declare function httpRouterHandler (routes: Route[]): middy.MiddlewareObj
 
 export default httpRouterHandler

package/index.js

@@ -1,3 +1,89 @@
-import{createError}from"@middy/util";const httpRouteHandler=routes=>{const routesStatic={};const routesDynamic={};const enumMethods=methods.concat("ANY");for(const route1 of routes){let{method,path,handler}=route1;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(handler!==undefined){return handler(event,context,abort)}for(const route of routesDynamic[method]??[]){if(route.path.test(path)){return route.handler(event,context,abort)}}throw createError(404,"Route does not exist")}};const regexpDynamicWildcards=/\/\{proxy\+\}/g;const regexpDynamicParameters=/\/\{.+\}/g;const methods=["GET","POST","PUT","PATCH","DELETE","OPTIONS"];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};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,"/?.*").replace(regexpDynamicParameters,"/.+");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})};export default httpRouteHandler
+import { createError } from '@middy/util';
+const httpRouteHandler = (routes)=>{
+    const routesStatic = {};
+    const routesDynamic = {};
+    const enumMethods = methods.concat('ANY');
+    for (const route1 of routes){
+        let { method , path , handler  } = route1;
+        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 (handler !== undefined) {
+            return handler(event, context, abort);
+        }
+        for (const route of routesDynamic[method] ?? []){
+            if (route.path.test(path)) {
+                return route.handler(event, context, abort);
+            }
+        }
+        throw createError(404, 'Route does not exist');
+    };
+};
+const regexpDynamicWildcards = /\/\{proxy\+\}/g;
+const regexpDynamicParameters = /\/\{.+\}/g;
+const methods = [
+    'GET',
+    'POST',
+    'PUT',
+    'PATCH',
+    'DELETE',
+    'OPTIONS'
+];
+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;
+};
+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, '/?.*').replace(regexpDynamicParameters, '/.+');
+    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
+        })
+};
+export default httpRouteHandler;
+
 
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-router",
-  "version": "3.0.2",
+  "version": "3.1.0-rc.0",
   "description": "HTTP event router for the middy framework",
   "type": "module",
   "engines": {
@@ -10,11 +10,17 @@
   "publishConfig": {
     "access": "public"
   },
+  "main": "./index.cjs",
   "exports": {
     ".": {
-      "import": "./index.js",
-      "require": "./index.cjs",
-      "types": "./index.d.ts"
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.cjs"
+      }
     }
   },
   "types": "index.d.ts",
@@ -55,10 +61,11 @@
   },
   "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "^3.0.2"
+    "@middy/util": "3.1.0-rc.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.2"
+    "@middy/core": "3.1.0-rc.0",
+    "@types/aws-lambda": "^8.10.97"
   },
-  "gitHead": "983649b8359ea32a786e75dfc2953aeee8ec6052"
+  "gitHead": "03a8794d3cdb4319eca49ba4c55420bea5d66430"
 }