Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vandium-io/vandium-node
AWS Lambda framework for building functions using Node.js for API Gateway, IoT applications, and other AWS events.
https://github.com/vandium-io/vandium-node
api-gateway aws-lambda iot jwt lambda serverless
Last synced: 2 days ago
JSON representation
AWS Lambda framework for building functions using Node.js for API Gateway, IoT applications, and other AWS events.
- Host: GitHub
- URL: https://github.com/vandium-io/vandium-node
- Owner: vandium-io
- License: bsd-3-clause
- Created: 2016-03-08T18:43:57.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T04:55:39.000Z (about 2 years ago)
- Last Synced: 2024-04-15T00:14:53.448Z (9 months ago)
- Topics: api-gateway, aws-lambda, iot, jwt, lambda, serverless
- Language: JavaScript
- Homepage:
- Size: 1.99 MB
- Stars: 388
- Watchers: 23
- Forks: 30
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/vandium-io/vandium-node)
[](https://badge.fury.io/js/vandium)
[AWS Lambda](https://aws.amazon.com/lambda/details) framework for building functions using [Node.js](https://nodejs.org) for
[API Gateway](https://aws.amazon.com/api-gateway), IoT applications, and other AWS events.
## Features
* Simplifies writing lambda handlers
* Automatically verifies event types
* Powerful input validation
* Works with [Serverless](https://serverless.com/)
* JSON Web Token (JWT) verification and validation
* JWK support for retrieving keys at startup
* Automatic loading of environment variables from SSM Parameter Store
* Cross Site Request Forgery (XSRF) detection when using JWT
* SQL Injection (SQLi) detection and protection
* Lambda Proxy Resource support for AWS API Gateway
* Handler initialization for allocating resources
* Post handler execution to allow deallocation of resources
* Forces values into correct types
* Handles uncaught exceptions
* Promise support
* Automatically trimmed strings for input event data
* Low startup overhead
* AWS Lambda Node.js 12.x
## Installation
Install via npm.
npm install vandium --save
## Getting Started
Vandium creates event specific handlers to reduce the amount of code than one
needs to maintain. The following handler code will respond with a message when
executed using the AWS API Gateway with a `GET` request:
```js
const vandium = require( 'vandium' );
// handler for an api gateway event
exports.handler = vandium.api()
.GET( (event) => {
// return greeting
return 'Hello ' + event.pathParmeters.name + '!';
});
```
The framework can process asynchronous responses using promises. The following
code returns a User object from a datastore asynchronously:
```js
const vandium = require( 'vandium' );
// our datastore access object
const Users = require( './users' );
// handler for an api gateway event
exports.handler = vandium.api()
.GET()
.validation({
pathParmeters: {
name: 'string:min=1,max=100,required'
}
})
.handler( async (event) => {
// returns a promise that resolves the User by name
return await Users.getUser( event.pathParmeters.name );
});
```
Additionally, resources can be closed at the end, success or failure, of the
handler. Failure to close resources might cause the lambda function to timeout
or run for longer than is required. The following code demonstrates closing a
cache after the handler has been called:
```js
const vandium = require( 'vandium' );
// our datastore access object
const Users = require( './users' );
// object caching - automatically connects on first access
const cache = require( './cache' );
// handler for an api gateway event
exports.handler = vandium.api()
.GET((event) => {
// returns a promise that resolves the User by name
return Users.getUser( event.pathParmeters.name );
})
.finally( () => {
// returns a promise that closes the cache connection
return cache.close();
});
```
Vandium supports the following types of AWS Lambda events:
- API Gateway
- Cloudformation
- Cloudwatch
- Cognito
- Dynamodb
- Kinesis
- Alexa
- S3
- Scheduled
- SES
- SNS
## Documentation
For documentation on how to use vandium in your project, please see our [documentation](docs) page.
## Feedback
We'd love to get feedback on how to make this tool better. Feel free to contact us at `[email protected]`
## License
[BSD-3-Clause](https://en.wikipedia.org/wiki/BSD_licenses)