🌜
🌞
@middy/event-normalizer

@middy/event-normalizer

v3.1.1

Parse and normalize AWS events middleware for the middy framework

npm install @middy/event-normalizer

README

Middy AWS event parse and normalization middleware

Middy logo

AWS event parsing and normalization 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/event-normalizer

Middleware for iterating through an AWS event records, parsing and normalizing nested events.

AWS Events Transformations: https://docs.aws.amazon.com/lambda/latest/dg/lambda-services.html

Event Source Included Comments
Alexa No Normalization not required
API Gateway (HTTP) No * See middleware prefixed with @middy/http-
API Gateway (REST) No * See middleware prefixed with @middy/http-
API Gateway (WS) No Opportunity for new middleware
Application LB No * See middleware prefixed with @middy/http-
CloudFormation No Normalization not required
CloudFront No Normalization not required
CloudTrail No Normalization not required
CloudWatch Logs Yes Base64 decode and JSON parse data
CodeCommit No Normalization not required
CodePipeline Yes JSON parse UserParameters
Cognito No Normalization not required
Config Yes JSON parse invokingEvent and ruleParameters
Connect No Normalization not required
DynamoDB Yes Unmarshall Keys, OldImage, and NewImage
EC2 No Normalization not required
EventBridge No Normalization not required
IoT No Normalization not required
IoT Event No Normalization not required
Kafka Yes Base64 decode and JSON parse value
Kafka (MSK) Yes Base64 decode and JSON parse value
Kinesis Firehose Yes Base64 decode and JSON parse data
Kinesis Stream Yes Base64 decode and JSON parse data
Lex No Normalization not required
MQ Yes Base64 decode and JSON parse data
RDS No Normalization not required
S3 Yes URI decode key
S3 Batch Yes URI decode s3Key
S3 Object Lambda No * See middleware @middy/s3-object-response
Secrets Manager No Normalization not required
SES No Normalization not required
SNS Yes JSON parse Message
SQS Yes JSON parse body

* Handled in another dedicated middleware(s)

Test Events Some events send test events after set, you will need to handle these.

// S3 Test Event
{
  Service: 'Amazon S3',
  Event: 's3:TestEvent',
  Time: '2020-01-01T00:00:00.000Z',
  Bucket: 'bucket-name',
  RequestId: '***********',
  HostId: '***/***/***='
}

Install

To install this middleware you can use NPM:

npm install --save @middy/event-normalizer

Sample usage

import middy from '@middy/core'
import eventNormalizer from '@middy/event-normalizer'

const lambdaHandler = (event, context) => {
  const { Records } = event
  for(const record of Records) {
    // ...
  }
}

const handler = middy(lambdaHandler).use(eventNormalizer())

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,028
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
10/219/220250
Last Commit
Open Issues
6
Closed Issues
407
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 (1)
Dev Dependencies (3)

Contributors

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