@middy/cloudformation-router 6.1.1

package/README.md

@@ -0,0 +1,46 @@
+<div align="center">
+  <h1>Middy cloudformation-router lambda handler</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
+  <p><strong>CloudFormation Custom Response 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/cloudformation-router?activeTab=versions">
+    <img src="https://badge.fury.io/js/%40middy%cloudformation-router.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://packagephobia.com/result?p=@middy/cloudformation-router">
+    <img src="https://packagephobia.com/badge?p=@middy/cloudformation-router" alt="npm install size" style="max-width:100%;">
+  </a>
+  <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/">
+    <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://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%;">
+  </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>
+<p>You can read the documentation at: <a href="https://middy.js.org/docs/routers/cloudformation-router">https://middy.js.org/docs/routers/cloudformation-router</a></p>
+</div>
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2024 [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%;">
+</a>

package/index.d.ts

@@ -0,0 +1,13 @@
+import middy from '@middy/core'
+import { CloudFormationCustomResourceHandler } from 'aws-lambda'
+
+interface Route<T = never> {
+  requestType: string
+  handler: CloudFormationCustomResourceHandler<T>
+}
+
+declare function cloudformationRouterHandler (
+  routes: Route[]
+): middy.MiddyfiedHandler
+
+export default cloudformationRouterHandler

package/index.js

@@ -0,0 +1,57 @@
+const defaults = {
+  routes: [],
+  notFoundResponse: ({ requestType }) => {
+    const err = new Error('Route does not exist', {
+      casue: {
+        package: '@middy/cloudformation-router',
+        data: { requestType }
+      }
+    })
+    throw err
+  }
+}
+const cloudformationCustomResourceRouteHandler = (opts = {}) => {
+  if (Array.isArray(opts)) {
+    opts = { routes: opts }
+  }
+  const { routes, notFoundResponse } = { ...defaults, ...opts }
+
+  const routesStatic = {}
+  for (const route of routes) {
+    const { requestType, handler } = route
+
+    // Static
+    routesStatic[requestType] = handler
+  }
+
+  const requestTypes = {
+    Create: true,
+    Update: true,
+    Delete: true
+  }
+  return (event, context, abort) => {
+    const { RequestType: requestType } = event
+    if (
+      !requestType ||
+      !Object.hasOwnProperty.call(requestTypes, requestType)
+    ) {
+      throw new Error('Unknown CloudFormation Custom Response event format', {
+        cause: {
+          package: '@middy/cloudformation-router',
+          data: { requestType }
+        }
+      })
+    }
+
+    // Static
+    if (Object.hasOwnProperty.call(routesStatic, requestType)) {
+      const handler = routesStatic[requestType]
+      return handler(event, context, abort)
+    }
+
+    // Not Found
+    return notFoundResponse({ requestType })
+  }
+}
+
+export default cloudformationCustomResourceRouteHandler

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@middy/cloudformation-router",
+  "version": "6.1.1",
+  "description": "CloudFormation Custom Response event router for the middy framework",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "default": "./index.js"
+      }
+    }
+  },
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "node --test __tests__/index.js",
+    "test:benchmark": "node __benchmarks__/index.js"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "CloudFormation",
+    "Custom Response",
+    "router"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/middyjs/middy.git",
+    "directory": "packages/cloudformation-router"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://middy.js.org",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/willfarrell"
+  },
+  "devDependencies": {
+    "@middy/core": "6.1.0",
+    "@types/aws-lambda": "^8.10.100"
+  },
+  "gitHead": "7a6c0fbb8ab71d6a2171e678697de9f237568431"
+}