@middy/http-cors 3.0.0-alpha.6 → 3.0.0

package/README.md

@@ -1,26 +1,36 @@
-# Middy CORS middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy CORS middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>CORS middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fhttp-cors">
+  <a href="https://www.npmjs.com/package/@middy/http-cors?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fhttp-cors.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/http-cors">
+    <img src="https://packagephobia.com/badge?p=@middy/http-cors" 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://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <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%;">
+    <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>
@@ -38,20 +48,20 @@ To install this middleware you can use NPM:
 npm install --save @middy/http-cors
 ```
 
-
 ## Options
 
- - `credentials` (bool) (optional): if true, sets `Access-Control-Allow-Credentials` (default `false`)
- - `headers` (string) (optional): value to put in `Access-Control-Allow-Headers` (default: `false`)
- - `methods` (string) (optional): value to put in `Access-Control-Allow-Methods` (default: `false`)
- - `getOrigin` (function(incomingOrigin:string, options)) (optional): take full control of the generating the returned origin. Defaults to using the origin or origins option.
- - `origin` (string) (optional): origin to put in the header (default: "`*`")
- - `origins` (array) (optional): An array of allowed origins. The incoming origin is matched against the list and is returned if present. 
- - `exposeHeaders` (string) (optional): value to put in `Access-Control-Expose-Headers` (default: `false`)
- - `maxAge` (string) (optional): value to put in Access-Control-Max-Age header (default: `null`)
- - `requestHeaders` (string) (optional): value to put in `Access-Control-Request-Headers` (default: `false`)
- - `requestMethods` (string) (optional): value to put in `Access-Control-Request-Methods` (default: `false`)
- - `cacheControl` (string) (optional): value to put in Cache-Control header on pre-flight (OPTIONS) requests (default: `null`)
+ - `credentials` (boolean) (default `undefined`): if true, sets `Access-Control-Allow-Credentials`
+ - `headers` (string) (default `undefined`): value to put in `Access-Control-Allow-Headers`
+ - `methods` (string) (default `undefined`): value to put in `Access-Control-Allow-Methods`
+ - `getOrigin` (function(incomingOrigin:string, options)): take full control of the generating the returned origin. Defaults to using the origin or origins option.
+ - `origin` (string) (default `'*'`): origin to put in the header
+ - `origins` (array) (default `[]`): An array of allowed origins. The incoming origin is matched against the list and is returned if present. 
+ - `exposeHeaders` (string) (default `undefined`): value to put in `Access-Control-Expose-Headers`
+ - `maxAge` (string) (default `undefined`): value to put in `Access-Control-Max-Age` header
+ - `requestHeaders` (string) (default `undefined`): value to put in `Access-Control-Request-Headers`
+ - `requestMethods` (string) (default `undefined`): value to put in `Access-Control-Request-Methods`
+ - `cacheControl` (string) (default `undefined`): value to put in `Cache-Control header` on pre-flight (OPTIONS) requests
+ - `vary` (string) (default `undefined`): value to put in `Vary`, will set to `Origin` if `Access-Control-Allow-Origin` is not `*` and option unset.
 
 ```javascript
 import middy from '@middy/core'

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 getOrigin=(incomingOrigin,options={})=>{if(options.origins.length>0){if(incomingOrigin&&options.origins.includes(incomingOrigin)){return incomingOrigin}else{return options.origins[0]}}else{if(incomingOrigin&&options.credentials&&options.origin==="*"){return incomingOrigin}return options.origin}};const defaults={getOrigin,credentials:undefined,headers:undefined,methods:undefined,origin:"*",origins:[],exposeHeaders:undefined,maxAge:undefined,requestHeaders:undefined,requestMethods:undefined,cacheControl:undefined,vary:undefined};const httpCorsMiddleware=(opts={})=>{const options={...defaults,...opts};const httpCorsMiddlewareAfter=async request=>{(0,_util).normalizeHttpResponse(request);const{headers}=request.response;const existingHeaders=Object.keys(headers);if(existingHeaders.includes("Access-Control-Allow-Credentials")){options.credentials=headers["Access-Control-Allow-Credentials"]==="true"}if(options.credentials){headers["Access-Control-Allow-Credentials"]=String(options.credentials)}if(options.headers&&!existingHeaders.includes("Access-Control-Allow-Headers")){headers["Access-Control-Allow-Headers"]=options.headers}if(options.methods&&!existingHeaders.includes("Access-Control-Allow-Methods")){headers["Access-Control-Allow-Methods"]=options.methods}if(!existingHeaders.includes("Access-Control-Allow-Origin")){const eventHeaders=request.event.headers??{};const incomingOrigin=eventHeaders.Origin??eventHeaders.origin;headers["Access-Control-Allow-Origin"]=options.getOrigin(incomingOrigin,options)}let vary=options.vary;if(headers["Access-Control-Allow-Origin"]!=="*"&&!vary){vary="Origin"}if(vary&&!existingHeaders.includes("Vary")){headers.Vary=vary}if(options.exposeHeaders&&!existingHeaders.includes("Access-Control-Expose-Headers")){headers["Access-Control-Expose-Headers"]=options.exposeHeaders}if(options.maxAge&&!existingHeaders.includes("Access-Control-Max-Age")){headers["Access-Control-Max-Age"]=String(options.maxAge)}if(options.requestHeaders&&!existingHeaders.includes("Access-Control-Request-Headers")){headers["Access-Control-Request-Headers"]=options.requestHeaders}if(options.requestMethods&&!existingHeaders.includes("Access-Control-Request-Methods")){headers["Access-Control-Request-Methods"]=options.requestMethods}const httpMethod=getVersionHttpMethod[request.event.version??"1.0"]?.(request.event);if(!httpMethod){throw new Error("[http-cors] Unknown http event format")}if(httpMethod==="OPTIONS"&&options.cacheControl&&!existingHeaders.includes("Cache-Control")){headers["Cache-Control"]=options.cacheControl}request.response.headers=headers};const httpCorsMiddlewareOnError=async request=>{if(request.response===undefined)return;return httpCorsMiddlewareAfter(request)};return{after:httpCorsMiddlewareAfter,onError:httpCorsMiddlewareOnError}};const getVersionHttpMethod={"1.0":event=>event.httpMethod,"2.0":event=>event.requestContext.http.method};var _default=httpCorsMiddleware;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.js

@@ -1,110 +1,3 @@
-import { normalizeHttpResponse } from '@middy/util';
+import{normalizeHttpResponse}from"@middy/util";const getOrigin=(incomingOrigin,options={})=>{if(options.origins.length>0){if(incomingOrigin&&options.origins.includes(incomingOrigin)){return incomingOrigin}else{return options.origins[0]}}else{if(incomingOrigin&&options.credentials&&options.origin==="*"){return incomingOrigin}return options.origin}};const defaults={getOrigin,credentials:undefined,headers:undefined,methods:undefined,origin:"*",origins:[],exposeHeaders:undefined,maxAge:undefined,requestHeaders:undefined,requestMethods:undefined,cacheControl:undefined,vary:undefined};const httpCorsMiddleware=(opts={})=>{const options={...defaults,...opts};const httpCorsMiddlewareAfter=async request=>{normalizeHttpResponse(request);const{headers}=request.response;const existingHeaders=Object.keys(headers);if(existingHeaders.includes("Access-Control-Allow-Credentials")){options.credentials=headers["Access-Control-Allow-Credentials"]==="true"}if(options.credentials){headers["Access-Control-Allow-Credentials"]=String(options.credentials)}if(options.headers&&!existingHeaders.includes("Access-Control-Allow-Headers")){headers["Access-Control-Allow-Headers"]=options.headers}if(options.methods&&!existingHeaders.includes("Access-Control-Allow-Methods")){headers["Access-Control-Allow-Methods"]=options.methods}if(!existingHeaders.includes("Access-Control-Allow-Origin")){const eventHeaders=request.event.headers??{};const incomingOrigin=eventHeaders.Origin??eventHeaders.origin;headers["Access-Control-Allow-Origin"]=options.getOrigin(incomingOrigin,options)}let vary=options.vary;if(headers["Access-Control-Allow-Origin"]!=="*"&&!vary){vary="Origin"}if(vary&&!existingHeaders.includes("Vary")){headers.Vary=vary}if(options.exposeHeaders&&!existingHeaders.includes("Access-Control-Expose-Headers")){headers["Access-Control-Expose-Headers"]=options.exposeHeaders}if(options.maxAge&&!existingHeaders.includes("Access-Control-Max-Age")){headers["Access-Control-Max-Age"]=String(options.maxAge)}if(options.requestHeaders&&!existingHeaders.includes("Access-Control-Request-Headers")){headers["Access-Control-Request-Headers"]=options.requestHeaders}if(options.requestMethods&&!existingHeaders.includes("Access-Control-Request-Methods")){headers["Access-Control-Request-Methods"]=options.requestMethods}const httpMethod=getVersionHttpMethod[request.event.version??"1.0"]?.(request.event);if(!httpMethod){throw new Error("[http-cors] Unknown http event format")}if(httpMethod==="OPTIONS"&&options.cacheControl&&!existingHeaders.includes("Cache-Control")){headers["Cache-Control"]=options.cacheControl}request.response.headers=headers};const httpCorsMiddlewareOnError=async request=>{if(request.response===undefined)return;return httpCorsMiddlewareAfter(request)};return{after:httpCorsMiddlewareAfter,onError:httpCorsMiddlewareOnError}};const getVersionHttpMethod={"1.0":event=>event.httpMethod,"2.0":event=>event.requestContext.http.method};export default httpCorsMiddleware
 
-const getOrigin = (incomingOrigin, options = {}) => {
-  if (options.origins.length > 0) {
-    if (incomingOrigin && options.origins.includes(incomingOrigin)) {
-      return incomingOrigin;
-    } else {
-      return options.origins[0];
-    }
-  } else {
-    if (incomingOrigin && options.credentials && options.origin === '*') {
-      return incomingOrigin;
-    }
-
-    return options.origin;
-  }
-};
-
-const defaults = {
-  getOrigin,
-  credentials: undefined,
-  headers: undefined,
-  methods: undefined,
-  origin: '*',
-  origins: [],
-  exposeHeaders: undefined,
-  maxAge: undefined,
-  requestHeaders: undefined,
-  requestMethods: undefined,
-  cacheControl: undefined
-};
-
-const httpCorsMiddleware = (opts = {}) => {
-  const options = { ...defaults,
-    ...opts
-  };
-
-  const httpCorsMiddlewareAfter = async request => {
-    var _getVersionHttpMethod;
-
-    normalizeHttpResponse(request);
-    const existingHeaders = Object.keys(request.response.headers);
-
-    if (existingHeaders.includes('Access-Control-Allow-Credentials')) {
-      options.credentials = request.response.headers['Access-Control-Allow-Credentials'] === 'true';
-    }
-
-    if (options.credentials) {
-      request.response.headers['Access-Control-Allow-Credentials'] = String(options.credentials);
-    }
-
-    if (options.headers && !existingHeaders.includes('Access-Control-Allow-Headers')) {
-      request.response.headers['Access-Control-Allow-Headers'] = options.headers;
-    }
-
-    if (options.methods && !existingHeaders.includes('Access-Control-Allow-Methods')) {
-      request.response.headers['Access-Control-Allow-Methods'] = options.methods;
-    }
-
-    if (!existingHeaders.includes('Access-Control-Allow-Origin')) {
-      const eventHeaders = request.event.headers ?? {};
-      const incomingOrigin = eventHeaders.origin ?? eventHeaders.Origin;
-      request.response.headers['Access-Control-Allow-Origin'] = options.getOrigin(incomingOrigin, options);
-    }
-
-    if (options.exposeHeaders && !existingHeaders.includes('Access-Control-Expose-Headers')) {
-      request.response.headers['Access-Control-Expose-Headers'] = options.exposeHeaders;
-    }
-
-    if (options.maxAge && !existingHeaders.includes('Access-Control-Max-Age')) {
-      request.response.headers['Access-Control-Max-Age'] = String(options.maxAge);
-    }
-
-    if (options.requestHeaders && !existingHeaders.includes('Access-Control-Request-Headers')) {
-      request.response.headers['Access-Control-Request-Headers'] = options.requestHeaders;
-    }
-
-    if (options.requestMethods && !existingHeaders.includes('Access-Control-Request-Methods')) {
-      request.response.headers['Access-Control-Request-Methods'] = options.requestMethods;
-    }
-
-    const httpMethod = (_getVersionHttpMethod = getVersionHttpMethod[request.event.version ?? '1.0']) === null || _getVersionHttpMethod === void 0 ? void 0 : _getVersionHttpMethod.call(getVersionHttpMethod, request.event);
-
-    if (!httpMethod) {
-      throw new Error('[http-cors] Unknown http event format');
-    }
-
-    if (httpMethod === 'OPTIONS') {
-      if (options.cacheControl && !existingHeaders.includes('Cache-Control')) {
-        request.response.headers['Cache-Control'] = String(options.cacheControl);
-      }
-    }
-  };
-
-  const httpCorsMiddlewareOnError = async request => {
-    if (request.response === undefined) return;
-    return httpCorsMiddlewareAfter(request);
-  };
-
-  return {
-    after: httpCorsMiddlewareAfter,
-    onError: httpCorsMiddlewareOnError
-  };
-};
-
-const getVersionHttpMethod = {
-  '1.0': event => event.httpMethod,
-  '2.0': event => event.requestContext.http.method
-};
-export default httpCorsMiddleware;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-cors",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0",
   "description": "CORS (Cross-Origin Resource Sharing) middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,10 +10,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "exports": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
   "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -45,12 +52,12 @@
   "bugs": {
     "url": "https://github.com/middyjs/middy/issues"
   },
-  "homepage": "https://github.com/middyjs/middy#readme",
-  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720",
+  "homepage": "https://middy.js.org",
+  "gitHead": "01520fa8628a36c2f89e126cad656a16547ea0d6",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.6"
+    "@middy/util": "^3.0.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.6"
+    "@middy/core": "^3.0.0"
   }
 }