@middy/http-response-serializer 4.0.0 → 4.0.1

package/README.md

@@ -36,126 +36,6 @@
 <p>You can read the documentation at: <a href="https://middy.js.org/docs/middlewares/http-response-serializer">https://middy.js.org/docs/middlewares/http-response-serializer</a></p>
 </div>
 
-The Http Serializer middleware lets you define serialization mechanisms based on the current content negotiation.
-
-
-## Install
-
-To install this middleware you can use NPM:
-
-```bash
-npm install --save @middy/http-response-serializer
-```
-
-
-## Configuration
-
-The middleware is configured by defining some `serializers`.
-
-```
-{
-  serializers: [
-    {
-      regex: /^application\/xml$/,
-      serializer: ({ body }) => `<message>${body}</message>`,
-    },
-    {
-      regex: /^application\/json$/,
-      serializer: ({ body }) => JSON.stringify(body)
-    },
-    {
-      regex: /^text\/plain$/,
-      serializer: ({ body }) => body
-    }
-  ],
-  defaultContentType: 'application/json'
-}
-```
-
-The `defaultContentType` (optional) option is used if the request and handler don't specify what type is wanted.
-
-
-## Serializer Functions
-
-When a matching serializer is found, the `Content-Type` header is set and the serializer function is run.
-
-The function is passed the entire `response` object, and should return either a string or an object.
-
-If a string is returned, the `body` attribute of the response is updated.
-
-If an object with a `body` attribute is returned, the entire response object is replaced. This is useful if you want to manipulate headers or add additional attributes in the Lambda response.
-
-
-## Content Type Negotiation
-
-The header is not the only way the middleware decides which serializer to execute.
-
-The content type is determined in the following order:
-
- * `event.requiredContentType` -- allows the handler to override everything else
- * The `Accept` header via [accept](https://www.npmjs.com/package/accept)
- * `event.preferredContentType` -- allows the handler to override the default, but lets the request ask first
- * `defaultContentType` middleware option
-
-All options allow for multiple types to be specified in your order of preference, and the first matching serializer will be executed.
-
-
-## Sample usage
-
-```javascript
-import middy from '@middy/core'
-import httpResponseSerializer from '@middy/http-response-serializer'
-
-const handler = middy((event, context) => {
-  const body = 'Hello World'
-
-  return {
-    statusCode: 200,
-    body
-  }
-})
-
-handler
-  .use(httpResponseSerializer({
-    serializers: [
-      {
-        regex: /^application\/xml$/,
-        serializer: ({ body }) => `<message>${body}</message>`,
-      },
-      {
-        regex: /^application\/json$/,
-        serializer: ({ body }) => JSON.stringify(body)
-      },
-      {
-        regex: /^text\/plain$/,
-        serializer: ({ body }) => body
-      }
-    ],
-    defaultContentType: 'application/json'
-  }))
-
-const event = {
-  headers: {
-    'Accept': 'application/xml;q=0.9, text/x-dvi; q=0.8, text/x-c'
-  }
-}
-
-handler(event, {}, (_, response) => {
-  t.is(response.body,'<message>Hello World</message>')
-})
-```
-
-
-## 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-response-serializer",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "The Http Serializer middleware lets you define serialization mechanisms based on the current content negotiation.",
   "type": "module",
   "engines": {
@@ -66,10 +66,10 @@
   "homepage": "https://middy.js.org",
   "dependencies": {
     "@hapi/accept": "6.0.0",
-    "@middy/util": "4.0.0"
+    "@middy/util": "4.0.1"
   },
   "devDependencies": {
-    "@middy/core": "4.0.0"
+    "@middy/core": "4.0.1"
   },
-  "gitHead": "582286144bcd79968a8c7c2f8867a23c80079a47"
+  "gitHead": "c5ece2bfbb0d607dcdea5685bf194a6cc19acc8d"
 }