@middy/http-content-negotiation 4.0.0 → 4.0.1

package/README.md

@@ -36,113 +36,6 @@
 <p>You can read the documentation at: <a href="https://middy.js.org/docs/middlewares/http-content-negotiation">https://middy.js.org/docs/middlewares/http-content-negotiation</a></p>
 </div>
 
-This middleware parses `Accept-*` headers and provides utilities for [HTTP content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3) (charset, encoding, language and media type).
-
-By default the middleware parses charsets (`Accept-Charset`), languages (`Accept-Language`), encodings (`Accept-Encoding`) and media types (`Accept`) during the
-`before` phase and expands the `event` object by adding the following properties:
-
-- `preferredCharsets` (`array`) - The list of charsets that can be safely used by the app (as the result of the negotiation)
-- `preferredCharset` (`string`) - The preferred charset (as the result of the negotiation)
-- `preferredEncodings` (`array`) - The list of encodings that can be safely used by the app (as the result of the negotiation)
-- `preferredEncoding` (`string`) - The preferred encoding (as the result of the negotiation)
-- `preferredLanguages` (`array`) - The list of languages that can be safely used by the app (as the result of the negotiation)
-- `preferredLanguage` (`string`) - The preferred language (as the result of the negotiation)
-- `preferredMediaTypes` (`array`) - The list of media types that can be safely used by the app (as the result of the negotiation)
-- `preferredMediaType` (`string`) - The preferred media types (as the result of the negotiation)
-
-This middleware expects the headers in canonical format, so it should be attached after the [`httpHeaderNormalizer`](#httpheadernormalizer) middleware.
-It also can throw an HTTP exception, so it can be convenient to use it in combination with the [`httpErrorHandler`](#httperrorhandler).
-
-
-## Install
-
-To install this middleware you can use NPM:
-
-```bash
-npm install --save @middy/http-content-negotiation
-```
-
-
-## Options
-
-- `parseCharsets` (boolean) (defaults to `true`) - Allows enabling/disabling the charsets parsing
-- `availableCharsets` (string) (defaults to `undefined`) - Allows defining the list of charsets supported by the Lambda function
-- `parseEncodings` (boolean) (defaults to `true`) - Allows enabling/disabling the encodings parsing
-- `availableEncodings` (string) (defaults to `undefined`) - Allows defining the list of encodings supported by the Lambda function
-- `parseLanguages` (boolean) (defaults to `true`) - Allows enabling/disabling the languages parsing
-- `availableLanguages` (string) (defaults to `undefined`) - Allows defining the list of languages supported by the Lambda function
-- `defaultToFirstLanguage` (boolean) (deafults to `false`) - Will set `preferredCharset` to the first value of `availableLanguages` if unset.
-- `parseMediaTypes` (boolean) (defaults to `true`) - Allows enabling/disabling the media types parsing
-- `availableMediaTypes` (string) (defaults to `undefined`) - Allows defining the list of media types supported by the Lambda function
-- `failOnMismatch` (boolean) (defaults to `true`) - If set to true it will throw an HTTP `NotAcceptable` (406) exception when the negotiation fails for one of the headers (e.g. none of the languages requested are supported by the app)
-
-
-## Sample usage
-
-```javascript
-import middy from '@middy/core'
-import httpContentNegotiation from '@middy/http-content-negotiation'
-import httpHeaderNormalizer from '@middy/http-header-normalizer'
-import httpErrorHandler from '@middy/http-error-handler'
-
-const handler = middy((event, context) => {
-  let message, body
-
-  switch (event.preferredLanguage) {
-    case 'it-it':
-      message = 'Ciao Mondo'
-      break
-    case 'fr-fr':
-      message = 'Bonjour le monde'
-      break
-    default:
-      message = 'Hello world'
-  }
-
-  switch (event.preferredMediaType) {
-    case 'application/xml':
-      body = `<message>${message}</message>`
-      break
-    case 'application/yaml':
-      body = `---\nmessage: ${message}`
-      break
-    case 'application/json':
-      body = JSON.stringify({ message })
-      break
-    default:
-      body = message
-  }
-
-  return {
-    statusCode: 200,
-    body
-  }
-})
-
-handler
-  .use(httpHeaderNormalizer())
-  .use(httpContentNegotiation({
-    parseCharsets: false,
-    parseEncodings: false,
-    availableLanguages: ['it-it', 'fr-fr', 'en'],
-    availableMediaTypes: ['application/xml', 'application/yaml', 'application/json', 'text/plain']
-  }))
-  .use(httpErrorHandler())
-
-export default { 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](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-content-negotiation",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Http content negotiation middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -62,11 +62,11 @@
   },
   "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "4.0.0",
+    "@middy/util": "4.0.1",
     "negotiator": "0.6.3"
   },
   "devDependencies": {
-    "@middy/core": "4.0.0"
+    "@middy/core": "4.0.1"
   },
-  "gitHead": "582286144bcd79968a8c7c2f8867a23c80079a47"
+  "gitHead": "c5ece2bfbb0d607dcdea5685bf194a6cc19acc8d"
 }