@middy/ws-router 3.0.0-alpha.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+<div align="center">
+  <h1>Middy ws-router lambda handler</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
+  <p><strong>WebSocket router for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+<p>
+  <a href="https://www.npmjs.com/package/@middy/ws-router?activeTab=versions">
+    <img src="https://badge.fury.io/js/%40middy%2Fws-router.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://packagephobia.com/result?p=@middy/ws-router">
+    <img src="https://packagephobia.com/badge?p=@middy/ws-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>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <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>
+  <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%;">
+  </a>
+  <br/>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
+  </a>
+</p>
+</div>
+
+This handler can route to requests to one of a nested handler based on `routeKey` of an WebSocket event from API Gateway (WebSocket).
+
+## Install
+
+To install this middleware you can use NPM:
+
+```bash
+npm install --save @middy/ws-router
+```
+
+## Options
+- `routes` (array[{method, path, handler}]) (required): Array of route objects.
+  - `routeKey` (string) (required): AWS formatted route key. ie `$connect`, `$disconnect`, `$default`
+  - `handler` (function) (required): Any `handler(event, context, {signal})` function
+
+NOTES:
+- Errors should be handled as part of the router middleware stack **or** the lambdaHandler middleware stack. Handled errors in the later will trigger the `after` middleware stack of the former.
+- Shared middlewares, connected to the router middleware stack, can only be run before the lambdaHandler middleware stack.
+
+## Sample usage
+
+```javascript
+import middy from '@middy/core'
+import wsRouterHandler from '@middy/ws-router'
+import wsResponseMiddleware from '@middy/ws-response'
+import validatorMiddleware from '@middy/validator'
+
+const connectHandler = middy()
+  .use(validatorMiddleware({inputSchema: {...} }))
+  .handler((event, context) => {
+    return 'connected'
+  })
+
+const disconnectHandler = middy()
+  .use(validatorMiddleware({inputSchema: {...} }))
+  .handler((event, context) => {
+    return 'disconnected'
+  })
+
+handler = middy()
+  .use(wsResponseMiddleware())
+  .handler(wsRouterHandler([
+    {
+      routeKey: '$connect',
+      handler: connectHandler
+    },
+    {
+      routeKey: '$disconnect',
+      handler: disconnectHandler
+    }
+  ]))
+  
+
+module.exports = { handler }
+```
+
+
+## Middy documentation and examples
+
+For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
+
+
+## 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).
+
+<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%;">
+</a>

package/index.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _util=require("@middy/util");const wsRouteHandler=routes=>{const routesStatic={};for(const route of routes){const{routeKey,handler}=route;routesStatic[routeKey]=handler}return(event,context,abort)=>{const{routeKey}=event.requestContext??{};if(!routeKey){throw new Error("[ws-router] Unknown ws event format")}const handler=routesStatic[routeKey];if(handler!==undefined){return handler(event,context,abort)}throw(0,_util).createError(404,"Route does not exist")}};var _default=wsRouteHandler;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.d.ts

@@ -0,0 +1,5 @@
+// import middy from '@middy/core'
+
+declare function wsRouterHandler (): any
+
+export default wsRouterHandler

package/index.js

@@ -0,0 +1,3 @@
+import{createError}from"@middy/util";const wsRouteHandler=routes=>{const routesStatic={};for(const route of routes){const{routeKey,handler}=route;routesStatic[routeKey]=handler}return(event,context,abort)=>{const{routeKey}=event.requestContext??{};if(!routeKey){throw new Error("[ws-router] Unknown ws event format")}const handler=routesStatic[routeKey];if(handler!==undefined){return handler(event,context,abort)}throw createError(404,"Route does not exist")}};export default wsRouteHandler
+
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@middy/ws-router",
+  "version": "3.0.0-alpha.8",
+  "description": "WebSocket event router for the middy framework",
+  "type": "module",
+  "engines": {
+    "node": ">=14"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.cjs",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "WebSocket",
+    "WS",
+    "router"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:middyjs/middy",
+    "directory": "packages/ws-router"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://middy.js.org",
+  "dependencies": {
+    "@middy/util": "^3.0.0-alpha.8"
+  },
+  "devDependencies": {
+    "@middy/core": "^3.0.0-alpha.8"
+  },
+  "gitHead": "c04b3a0c2f326906b34973878d6f823778a5ea99"
+}