🌜
🌞
@middy/http-response-serializer

@middy/http-response-serializer

v3.1.1

The Http Serializer middleware lets you define serialization mechanisms based on the current content negotiation.

npm install @middy/http-response-serializer

README

Middy http-response-serializer middleware

Middy logo

HTTP response serializer middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

npm version npm install size GitHub Actions CI status badge
Standard Code Style Known Vulnerabilities Language grade: JavaScript Core Infrastructure Initiative (CII) Best Practices
Chat on Gitter Ask questions on StackOverflow

You can read the documentation at: https://middy.js.org/docs/middlewares/http-response-serializer

The Http Serializer middleware lets you define serialization mechanisms based on the current content negotiation.

Install

To install this middleware you can use NPM:

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
    }
  ],
  default: '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
  • 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

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 or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status

Release Notes

3.1.1
By will Farrell • Published on August 4, 2022

What's Changed

  • Add in module to package.json files @willfarrell
  • performance improvements @willfarrell

TypeScript

Docs

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.1.0...3.1.1

3.1.0
By will Farrell • Published on June 21, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.4...3.1.0

3.0.4
By will Farrell • Published on June 4, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.3...3.0.4

3.0.3
By will Farrell • Published on May 17, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.2...3.0.3

3.0.2
By will Farrell • Published on May 13, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.1...3.0.2

3.0.1
By will Farrell • Published on May 13, 2022

What's Changed

  • Updated dependencies

Full Changelog: https://github.com/middyjs/middy/compare/3.0.0...3.0.1

2.5.7
By will Farrell • Published on January 25, 2022

Fix publishing transpiling error in 2.5.6. Thanks to @maximepichou and @rreubenreyes for reporting.

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,032
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
10/219/220250
Last Commit
Open Issues
4
Closed Issues
409
Open Pull Requests
1
Closed Pull Requests
149

Versions

Versions Released
10/219/22010
Latest Version Released
Aug 4, 2022
Current Tags
latest3.1.1
next3.1.0-rc.1

Dependencies

Dependencies (2)
Dev Dependencies (2)

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
vladgolubev
vladgolubev
Commits: 12
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
thejuan
thejuan
Commits: 12
dkatavic
dkatavic
Commits: 11
gsingh1
gsingh1
Commits: 10
joseSantacruz
joseSantacruz
Commits: 9
leog
leog
Commits: 6
theburningmonk
theburningmonk
Commits: 6
ossareh
ossareh
Commits: 5
munierujp
munierujp
Commits: 4
JimiPedros
JimiPedros
Commits: 4
sdomagala
sdomagala
Commits: 4
chris-heathwood-uoy
chris-heathwood-uoy
Commits: 3